apple_auth 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6e2838dce13def54be641c346b9618bb3e3bdc10288b98a2accb639e3ea107
-  data.tar.gz: c6a16b50b7d59bdf788385d4718d6664e94d6206fbcb2febbe73e92ec4e25440
+  metadata.gz: 2325fb23f530c7f590aa0b2fa733af052923478e81a6ccc82c4d86963514a7da
+  data.tar.gz: 9551b96c8c9a1feebaa2ffc6f64fe9f66e6a36787d63805bff81c315a43897d4
 SHA512:
-  metadata.gz: 18707eddc8b74cc651477b0464dd890c83b4d8c5acb3080d0943c5a6eb6fa5a2c8f808c4e2c8ca9ab9c757f89d1c2494a04f4ff044e5f5ae8484893a5745d6fb
-  data.tar.gz: 8abc50e0cef074c7228ab3e7e2fe64822161f9b1c724e2b62877ecd8b23caf8862ff305d1b8025bbf0e8892a38559aef90c736aead513aacd4f801e9685cec2d
+  metadata.gz: aa21c140b1c060c38b6fa56f76339b3572f8d4e1d4deca9c761e1a58467950d89244937fa185d22872595ea49215200603efc06a50761712f82f7beac79574a6
+  data.tar.gz: bc1edcfca29b8176ecfec0fdf74c50065e1d1c313974a8bb8a441fa3300037c495b1ae013a71145e9d9def053de9ec002134289209250ad288b95baa87969dd9

data/.reek.yml

@@ -126,3 +126,5 @@ detectors:
 
 exclude_paths:
   - config
+  - lib/generators/apple_auth/apple_auth_controller/templates
+

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  TargetRubyVersion:  2.5
+  Exclude:
+    - lib/generators/apple_auth/apple_auth_controller/templates/**
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -1,16 +1,12 @@
 # AppleAuth
 
-[![CI](https://travis-ci.org/rootstrap/apple_sign_in.svg?branch=master)](https://travis-ci.org/rootstrap/apple_sign_in)
+[![CI](https://api.travis-ci.org/rootstrap/apple_auth.svg?branch=master)](https://travis-ci.org/github/rootstrap/apple_auth)
 [![Maintainability](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/maintainability)](https://codeclimate.com/github/rootstrap/apple_sign_in/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/test_coverage)](https://codeclimate.com/github/rootstrap/apple_sign_in/test_coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apple_auth`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your Gemfile:
 
 ```ruby
 gem 'apple_auth'
@@ -20,18 +16,18 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install apple_auth
 
 ------------------
 
-After installing the gem, you need to run the generator.
+After installing the gem, you need to run this generator.
 
     $ rails g apple_auth:config
 
-This will generate a new initializer: `apple_auth.rb` containing the following default configuration:
-```
+This will generate a new initializer: `apple_auth.rb` with the following default configuration:
+```ruby
 AppleAuth.configure do |config|
   # config.apple_client_id = <Your client_id in your Apple Developer account>
   # config.apple_private_key = <Your private key provided by Apple>
@@ -42,9 +38,11 @@ end
 ```
 Set your different credentials in the file by uncommenting the lines and adding your keys.
 
+------------------
+
 ## Usage
 
-This show you an example of a settings
+Here's an example of how to configure the gem:
 
 ```ruby
 AppleAuth.configure do |config|
@@ -56,13 +54,13 @@ AppleAuth.configure do |config|
 end
 ```
 
-We strongly recommend to use environment variable when you add this values.
+We strongly recommend to use environment variables for these values.
 
-Apple sign in workflow:
+Apple sign-in workflow:
 
 ![alt text](https://docs-assets.developer.apple.com/published/360d59b776/rendered2x-1592224731.png)
 
-For more information, check the [Apple oficial documentation](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_rest_api)
+For more information, check the [Apple oficial documentation](https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_rest_api).
 
 Validate JWT token and get user information:
 
@@ -81,14 +79,39 @@ AppleAuth::UserIdentity.new(user_id, invalid_jwt_token).validate!
 >>  AppleAuth::Conditions::JWTValidationError
 ```
 
-Verify user identity and get token:
+Verify user identity and get access and refresh tokens:
 
 ```ruby
 code = 'cfb77c21ecd444390a2c214cd33decdfb.0.mr...'
-AppleAuth::Token.new(code).authenticate
+AppleAuth::Token.new(code).authenticate!
 >> { access_token: "a7058d...", expires_at: 1595894672, refresh_token: "r8f1ce..." }
 ```
 
+## Using with Devise
+
+If you are using devise_token_auth gem, run this generator.
+
+    $ rails g apple_sign_in:appple_auth_controller [scope]
+
+In the scope you need to write your path from controllers to your existent devise controllers.
+An example `$ rails g apple_auth:appple_auth_controller api/v1/`
+This will generate a new controller: `controllers/api/v1/apple_auth_controller.rb`.
+
+You should configure the route, you can wrap it in the devise_scope block like:
+```
+devise_scope :user do
+  resource :user, only: %i[update show] do
+    controller :apple_auth do
+      post :apple_auth, on: :collection, to: 'apple_auth#create'
+    end
+  end
+end
+```
+
+## Demo
+
+You can find a full implementation of this gem in [this demo](https://github.com/rootstrap/apple-sign-in-rails).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -97,7 +120,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apple_sign_in. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/apple_auth/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/apple_auth/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/apple_auth/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -106,11 +129,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the AppleAuth project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apple_auth/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the AppleAuth project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/apple_auth/blob/master/CODE_OF_CONDUCT.md).
 
 ## Credits
 
-apple_auth is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our
-[contributors](https://github.com/rootstrap/apple_sign_in/contributors).
+apple_auth gem is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our
+[contributors](https://github.com/rootstrap/apple_auth/contributors).
 
 [<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/apple_auth.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Timothy Peraza, Antonieta Alvarez, Martín Morón']
   spec.email         = ['timothy@rootstrap.com, antonieta.alvarez@rootstrap.com, martin.jaime@rootstrap.com']
 
-  spec.summary       = 'Integration with Apple Sign In'
+  spec.summary       = 'Integration with Apple Sign In and Devise for backend. Validate and Verify user token.'
   spec.homepage      = 'https://github.com/rootstrap/apple_auth'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'reek', '~> 5.6'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.80'
+  spec.add_development_dependency 'parser', '~> 2.7.1.1'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock', '~> 3.8'
 end

data/lib/apple_auth.rb

@@ -27,3 +27,4 @@ require 'apple_auth/user_identity'
 require 'apple_auth/token'
 
 require 'generators/apple_auth/config/config_generator'
+require 'generators/apple_auth/apple_auth_controller/apple_auth_controller_generator'

data/lib/apple_auth/base/version.rb

@@ -2,6 +2,6 @@
 
 module AppleAuth
   module Base
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/apple_auth/token.rb

@@ -12,7 +12,7 @@ module AppleAuth
     end
 
     # :reek:FeatureEnvy
-    def authenticate
+    def authenticate!
       access_token = apple_access_token
       access_token.refresh! if access_token.expired?
 

data/lib/generators/apple_auth/apple_auth_controller/apple_auth_controller_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AppleAuth
+  module Generators
+    class AppleAuthControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      argument :scope, required: false, default: ''
+
+      def copy_apple_auth_controller_file
+        @scope_prefix = scope.blank? ? '' : scope.camelize
+        template 'apple_auth_controller.rb',
+                 "app/controllers/#{scope}apple_auth_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/apple_auth/apple_auth_controller/templates/apple_auth_controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>AppleAuthController < DeviseTokenAuth::SessionsController
+  protect_from_forgery with: :null_session
+  skip_before_action :verify_authenticity_token
+  before_action :skip_session_storage
+  before_action :check_json_request
+
+  def create
+    apple_params = apple_validate
+    @resource = sign_in_with_apple(apple_params)
+    custom_sign_in
+  rescue AppleAuth::Conditions::JWTValidationError, OAuth2::Error, JWT::ExpiredSignature => e
+    render_error(:bad_request, e.message)
+  end
+
+  private
+
+  def apple_validate
+    data = AppleAuth::UserIdentity.new(
+      apple_sign_in_params[:user_identity],
+      apple_sign_in_params[:jwt]
+    ).validate!
+    AppleAuth::Token.new(apple_sign_in_params[:code]).authenticate!
+
+    data.slice(:email)
+  end
+
+  def custom_sign_in
+    sign_in(:api_v1_user, @resource)
+    new_auth_header = @resource.create_new_auth_token
+    response.headers.merge!(new_auth_header)
+    render_create_success
+  end
+
+  def sign_in_with_apple(user_params)
+    user = User.where(provider: 'apple', uid: user_params[:email]).first_or_create!
+    user.password = Devise.friendly_token[0, 20]
+    user.assign_attributes user_params.except('id')
+    user
+  end
+
+  def apple_sign_in_params
+    params.permit(:user_identity, :jwt, :code)
+  end
+
+  def check_json_request
+    return if request_content_type&.match?(/json/)
+
+    render json: { error: I18n.t('api.errors.invalid_content_type') }, status: :not_acceptable
+  end
+
+  def render_create_success
+    render json: { user: resource_data }
+  end
+
+  def render_error(status, message, _data = nil)
+    response = {
+      error: message
+    }
+    render json: response, status: status
+  end
+
+  def skip_session_storage
+    # Devise stores the cookie by default, so in api requests, it is disabled
+    # http://stackoverflow.com/a/12205114/2394842
+    request.session_options[:skip] = true
+  end
+
+  def request_content_type
+    request.content_type
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Timothy Peraza, Antonieta Alvarez, Martín Morón
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +211,8 @@ files:
 - lib/apple_auth/helpers/jwt_conditions.rb
 - lib/apple_auth/token.rb
 - lib/apple_auth/user_identity.rb
+- lib/generators/apple_auth/apple_auth_controller/apple_auth_controller_generator.rb
+- lib/generators/apple_auth/apple_auth_controller/templates/apple_auth_controller.rb
 - lib/generators/apple_auth/config/config_generator.rb
 - lib/generators/apple_auth/config/templates/config.rb
 homepage: https://github.com/rootstrap/apple_auth
@@ -224,5 +240,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Integration with Apple Sign In
+summary: Integration with Apple Sign In and Devise for backend. Validate and Verify
+  user token.
 test_files: []