First working API implementation #51

jameswthorne · 2017-01-12T14:07:54Z

This is my attempt at adding an API to SnapPass. I used this implementation about 8 months ago when I needed to generate a lot of SnapPass URLs for a project at my previous employer.

It was previously mentioned by one of the maintainers they wanted to keep apart the web form code and any API code. This doesn't currently do that, but I am interested in discussing the appropriate way to do that.

jameswthorne · 2017-01-12T14:29:48Z

Now that SnapPass supports multi-line passwords/secrets, I don't know the best way to handle that when POSTing via curl.

jparise

I think the error handling could use a rethink. Flask has a nice errorhandle system that delegates error response building to registered functions. That way, the view functions can just abort(status_code).

jparise · 2017-01-12T16:07:04Z

snappass/main.py

@@ -6,7 +6,7 @@
 import redis
 from redis.exceptions import ConnectionError

-from flask import abort, Flask, render_template, request
+from flask import abort, Flask, render_template, request, jsonify


Can we retain the alphabetized order?

jparise · 2017-01-12T16:10:33Z

snappass/main.py

+    resp = jsonify(data)
+    resp.status_code = 200
+
+    return resp


You can just do:

return jsonify(data)

... because the response defaults to 200.

jparise · 2017-01-12T16:12:16Z

snappass/main.py

+    if NO_SSL:
+        base_url = request.url_root
+    else:
+        base_url = request.url_root.replace("http://", "https://")


These four lines are repeated in multiple endpoint functions. Can we factor them into a common make_base_url() function?

Alternatively, we could just require flask-sslify, which would move this concern out of snappass.

jparise · 2017-01-12T16:15:12Z

snappass/main.py

@@ -90,12 +90,53 @@ def request_is_valid(request):
    """
    return not SNEAKY_USER_AGENTS_RE.search(request.headers.get('User-Agent', ''))

+def not_found_api(error=None):


The error parameter doesn't appear to be passed or used in any code paths.

jparise · 2017-01-12T16:15:41Z

snappass/main.py

+    resp = jsonify(message)
+    resp.status_code = 404
+
+    return resp


Flask has a nice shortcut for this pattern:

return make_response(jsonify(message), 404)

jameswthorne · 2017-01-13T02:11:52Z

I'm working on applying your suggested fixes.

Is there a way to not have the abort() function output HTML?

jparise · 2017-01-13T02:58:14Z

Is there a way to not have the abort() function output HTML?

Yes, that's where the errorhandler bit comes in:

@app.errorhandler(404)
def not_found(error):
    message = {
        'status': error.status_code,
        'message': 'Not Found: ' + request.url,
    }

    return make_response(jsonify(message), error.status_code)

nichochar · 2017-05-03T03:00:25Z

Hey just letting you know this is not dead. I just need to find a little time to review it, probably in the next week or so!

jameswthorne · 2017-05-03T03:05:16Z

Hey @nichochar, no problem! No rush at all. I haven't had a chance to dive back into this yet.

ghost · 2017-11-01T14:13:03Z

Any progress on this one?

bryanpost · 2018-01-29T20:48:56Z

Any progress on this getting rolled into the main build?

coyotwill · 2018-02-09T16:08:10Z

snappass/main.py

+        if not len(password) > 0:
+            return bad_request_api()
+    else:
+        return bad_request_api()


Pretty complex logic here. How about something like :

password = payload.get('password', None) if not password: #edit: not need to check len since empty strings are falsy return bad_request_api()

coyotwill · 2018-02-09T16:09:54Z

snappass/main.py

+        ttl = time_conversion[time_period]
+    else:
+        # Set ttl to one week if not specified in the JSON
+        ttl = 604800


same here, could do time_period = payload.get('ttl', 'week').lower()

coyotwill · 2018-02-09T16:15:57Z

snappass/main.py

+    base_url = make_base_url()
+
+    return "Generate a password share link with the following command: \n\n" \
+           "curl -X POST -d \'{\"password\":\"password-here\",\"ttl\":\"week | day | hour\"}\' -H \"Content-Type:application/json\" " + base_url + "api\n"


Minor: using single quotes to quote the string would allow to put unescaped double quotes in it. Makes it easier to read. 'curl -X POST -d \'{"password":"password-here","ttl":"week | day | hour"}\' -H ...'

Deprecate support for py26 and py33

Quote url to fix equal sign breaking outlook clients

Mock redis

nichochar · 2018-05-07T16:32:22Z

Looking back at this, it looks pretty good. One thing that is missing that I'd love to see is some tests.

I think that with a rebase and some tsts we can pull it in @jameswthorne. Let me know if you're still interested in contributing, we've been a little slow to respond! If not I'll take this over and push it through, since I think an API is a good idea.

Bump version to 1.3.0

Remove support for py26 and py33 from readme

Since Python 2.6 support was dropped, we can use all these: https://docs.python.org/2/library/unittest.html#assert-methods

This ensures the failure message, if any, is reflective of the intended value.

…ests Enhancement/modernize tests

jameswthorne · 2018-06-05T15:44:22Z

Hey @nichochar

It's been sometime since I've looked over the code. I will try and find sometime this week to rebase and review.

nichochar · 2018-06-06T02:53:48Z

Awesome thanks @jameswthorne. Let me know if this is hard for you and I'm happy to commandeer the PR, it's up to you!

Add hiring plug in readme

Changed cryptography requirement to >= because of install issues

jameswthorne · 2018-07-01T19:46:02Z

I rebased from the latest master and incorporated suggested fixes from @coyotwill.

I still need to incorporate the necessary tests.

jameswthorne · 2019-01-16T14:14:43Z

How life gets in the way. I'm planning on rebasing from master and writing the tests this month.

silverl · 2019-07-05T14:54:07Z

Came here looking for an API for SnapPass. Any progress on getting this baked in? Thank you.

Dragonpark · 2020-01-23T20:28:38Z

Was hoping there would be an update to this, but it seems the PR author has gone silent. Would be great if somebody could pick this back up.

The API implementation from jameswthorne (https://github.com/jameswthorne) has been re-imported into the latest version of snappass. Pull request from jameswthorne can be found here: pinterest#51

jameswthorne · 2023-09-30T22:41:36Z

I have no plans to revisit this PR. Someone else please feel free to adapt my code. Closing.

First working API implementation

524feac

jameswthorne mentioned this pull request Jan 12, 2017

Make possible to get the password via Curl #36

Open

jparise reviewed Jan 12, 2017

View reviewed changes

Applied suggested fixes from jparise

bf93da4

nichochar mentioned this pull request Mar 31, 2017

Feature : Add view limit possibility and date limit #56

Closed

coyotwill reviewed Feb 9, 2018

View reviewed changes

Nicholas Charriere and others added 12 commits May 6, 2018 12:45

Deprecate support for py26 and py34

7fc18ec

Merge pull request pinterest#78 from pinterest/deprectate-py26-py34

b8ce29e

Deprecate support for py26 and py33

Mock redis in tests using mockredis

331d421

Remove -s flag in tests

2e0a296

Remove 2.6 and 3.3 from .travis.yml

f59fd33

Quote url to fix equal sign breaking outlook clients

5a0beb1

py2 and py3 support

9e7ca47

Use werkzeug quote/unquote functions instead of urllib

13f294c

Make mock a requirement, not dev-requirement

75b6a69

Merge pull request pinterest#80 from pinterest/quoteurls

68b4cec

Quote url to fix equal sign breaking outlook clients

Merge pull request pinterest#79 from pinterest/mock-redis

173f33f

Mock redis

Bump version to 1.3.0

e45feb1

nichochar and others added 2 commits May 7, 2018 09:45

Merge pull request pinterest#81 from pinterest/bumpversion-1.3.0

6fe4733

Bump version to 1.3.0

Remove support for py26 and py33 from readme

699293b

nichochar and others added 6 commits May 7, 2018 10:01

Merge pull request pinterest#82 from pinterest/readme-update

548c998

Remove support for py26 and py33 from readme

Use assertion methods introduced in Python 2.7

e6eca0d

Since Python 2.6 support was dropped, we can use all these: https://docs.python.org/2/library/unittest.html#assert-methods

Fix assertEqual parameter order (expected, actual)

80f77a6

This ensures the failure message, if any, is reflective of the intended value.

Drop the dot in py.test (as recommended by pytest)

d407c26

Merge pull request pinterest#83 from samueldg/enhancement/modernize-t…

5ddecd4

…ests Enhancement/modernize tests

Add hiring plug in readme

a2d4245

nichochar and others added 5 commits June 16, 2018 10:17

Merge pull request pinterest#84 from pinterest/shameless-hiring-plug

a42815d

Add hiring plug in readme

First working API implementation

339dc0c

Applied suggested fixes from jparise

23c3c81

Rebased from master and incorporated suggested fixes

7be6307

Changed cryptography requirement to >= because of install issues

Merge branch 'api' of https://github.com/jameswthorne/snappass into api

380af3c

jparise mentioned this pull request Feb 3, 2021

Question about creation of multiple links #136

Closed

jameswthorne closed this Sep 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First working API implementation #51

First working API implementation #51

jameswthorne commented Jan 12, 2017

jameswthorne commented Jan 12, 2017

jparise left a comment

jparise Jan 12, 2017

jparise Jan 12, 2017

jparise Jan 12, 2017

jparise Jan 12, 2017

jparise Jan 12, 2017

jameswthorne commented Jan 13, 2017

jparise commented Jan 13, 2017

nichochar commented May 3, 2017

jameswthorne commented May 3, 2017

ghost commented Nov 1, 2017

bryanpost commented Jan 29, 2018

coyotwill Feb 9, 2018 •

edited

Loading

coyotwill Feb 9, 2018

coyotwill Feb 9, 2018

nichochar commented May 7, 2018

jameswthorne commented Jun 5, 2018

nichochar commented Jun 6, 2018

jameswthorne commented Jul 1, 2018

jameswthorne commented Jan 16, 2019

silverl commented Jul 5, 2019

Dragonpark commented Jan 23, 2020

jameswthorne commented Sep 30, 2023

First working API implementation #51

First working API implementation #51

Conversation

jameswthorne commented Jan 12, 2017

jameswthorne commented Jan 12, 2017

jparise left a comment

Choose a reason for hiding this comment

jparise Jan 12, 2017

Choose a reason for hiding this comment

jparise Jan 12, 2017

Choose a reason for hiding this comment

jparise Jan 12, 2017

Choose a reason for hiding this comment

jparise Jan 12, 2017

Choose a reason for hiding this comment

jparise Jan 12, 2017

Choose a reason for hiding this comment

jameswthorne commented Jan 13, 2017

jparise commented Jan 13, 2017

nichochar commented May 3, 2017

jameswthorne commented May 3, 2017

ghost commented Nov 1, 2017

bryanpost commented Jan 29, 2018

coyotwill Feb 9, 2018 • edited Loading

Choose a reason for hiding this comment

coyotwill Feb 9, 2018

Choose a reason for hiding this comment

coyotwill Feb 9, 2018

Choose a reason for hiding this comment

nichochar commented May 7, 2018

jameswthorne commented Jun 5, 2018

nichochar commented Jun 6, 2018

jameswthorne commented Jul 1, 2018

jameswthorne commented Jan 16, 2019

silverl commented Jul 5, 2019

Dragonpark commented Jan 23, 2020

jameswthorne commented Sep 30, 2023

coyotwill Feb 9, 2018 •

edited

Loading