motion-authentication 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88c921f20aa4544926a47cae648753a20dbbab4a
+  data.tar.gz: bb8c436ffc5f4116084f3540a7f5f7c53a5d2cbb
+SHA512:
+  metadata.gz: f79627619ffade80b261dcb7038e85c96d98556baeef095402e0cccd79ddee84b35ee34c1ade5202ebc50389f8d00bcdf0ce5e39df9d8e2217d1c96d8b93aa81
+  data.tar.gz: 4c56cc20639741eac36e5868f4310a52fdbf68067c29a8edd4c540eb97a5a17fe68d9d404b1afd907d4fea2c8ea7eb4bb82a6a0636891f2c9f86f422d37a5db3

data/README.md

@@ -0,0 +1,112 @@
+# motion-authentication
+
+`motion-authentication` aims to provide a simple, standardized authentication helper for common authentication strategies.
+
+Currently, this library only supports iOS, but could easily support other platforms. Please submit an issue (or PR :D) for the platform you would like to support.
+
+## Installation
+
+Add this line to your application's `Gemfile`, then run `bundle install`:
+
+    gem 'motion-authentication'
+
+Next, run `rake pod:install` to install the CocoaPod dependencies.
+
+## Usage
+
+Start by subclassing `Motion::Authentication` to create your own `Auth` class. Specify your authentication strategy and your sign in URL:
+
+```ruby
+class Auth < Motion::Authentication
+  strategy DeviseTokenAuth
+  sign_in_url "http://localhost:3000/api/v1/users/sign_in"
+end
+```
+
+Available strategies:
+
+* `DeviseTokenAuth` - This authentication strategy takes `email` and `password`, makes a POST request to the `sign_in_url`, and expects the response to include `email` and `token` keys in the JSON response object.
+
+### `.sign_in`
+
+Using your `Auth` class, call `.sign_in` and pass a hash of credentials:
+
+```ruby
+Auth.sign_in(email: email, password: password) do |result|
+  if result.success?
+    # authentication successful!
+  else
+    app.alert "Invalid login?"
+  end
+end
+```
+
+A successful sign in will securely store the current user's auth token.
+
+### `.signed_in?`
+
+You can check if an auth token has previously been stored by using `signed_in?`. For example, in your App Delegate, you might want to open your sign in screen when the app is opened:
+
+```ruby
+def on_load(options)
+  if Auth.signed_in?
+    open DashboardScreen
+  else
+    open SignInScreen
+  end
+end
+```
+
+### `.authorization_header`
+
+After signing in, and receiving the auth token, you will probably want to configure your API client to use your auth token in your API requests in an authorization header. Call `.authorization_header` to return the header value specific to the strategy that you are using. Two common places would be upon sign in, and when your app is launched.
+
+```ruby
+# app_delegate.rb
+def on_load(options)
+  if Auth.signed_in?
+    MyApiClient.update_auth_header(Auth.authorization_header)
+    # ...
+  end
+end
+
+# sign_in_screen.rb
+def on_load(options)
+  Auth.sign_in(data) do |result|
+    if result.success?
+      MyApiClient.update_auth_header(Auth.authorization_header)
+      # ...
+    end
+  end
+end
+```
+
+### `.sign_out`
+
+At some point, you're going to need to sign out. This method will clear the stored auth token, but also allows you to pass a block to be called after the token has been cleared.
+
+```ruby
+Auth.sign_out do
+  open HomeScreen
+end
+```
+
+### `.current_user`
+
+`motion-authentication` provides a `current_user` attribute. It has no effect on authentication, so you can do whatever you want with it.
+
+```ruby
+Auth.sign_in(data) do |result|
+  if result.success?
+    Auth.current_user = User.new(result.object)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/motion-authentication.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require 'motion-cocoapods'
+require 'motion-keychain'
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
+end

data/lib/project/motion-authentication.rb

@@ -0,0 +1,33 @@
+class Motion
+  class Authentication
+    class << self
+      attr_accessor :current_user
+
+      def strategy(val = nil)
+        @strategy = val unless val.nil?
+        @strategy ||= DeviseTokenAuth
+      end
+
+      def sign_in_url(val = nil)
+        @sign_in_url = val unless val.nil?
+        @sign_in_url
+      end
+
+      def sign_in(params, &block)
+        strategy.sign_in(sign_in_url, params, &block)
+      end
+
+      def authorization_header
+        strategy.authorization_header
+      end
+
+      def signed_in?
+        strategy.signed_in?
+      end
+
+      def sign_out(&block)
+        strategy.sign_out(&block)
+      end
+    end
+  end
+end

data/lib/project/strategies/devise_token_auth.rb

@@ -0,0 +1,37 @@
+module Motion
+  class Authentication
+    class DeviseTokenAuth
+      class << self
+        def sign_in(sign_in_url, params, &block)
+          AFMotion::JSON.post(sign_in_url, user: params) do |response|
+            if response.success?
+              store_auth_tokens(response.object)
+            end
+            block.call(response)
+          end
+        end
+
+        def store_auth_tokens(data)
+          MotionKeychain.set :auth_email, data["email"]
+          MotionKeychain.set :auth_token, data["token"]
+        end
+
+        def authorization_header
+          token = MotionKeychain.get :auth_token
+          email = MotionKeychain.get :auth_email
+          %Q|Token token="#{token}", email="#{email}"|
+        end
+
+        def signed_in?
+          !! MotionKeychain.get(:auth_token)
+        end
+
+        def sign_out(&block)
+          MotionKeychain.remove :auth_email
+          MotionKeychain.remove :auth_token
+          block.call
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: motion-authentication
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Havens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion-keychain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, standardized authentication helper for common authentication
+  strategies for RubyMotion apps.
+email:
+- email@andrewhavens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-authentication.rb
+- lib/project/motion-authentication.rb
+- lib/project/strategies/devise_token_auth.rb
+homepage: https://github.com/andrewhavens/motion-authentication
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple, standardized authentication helper for common authentication strategies
+  for RubyMotion apps.
+test_files: []