omniauth-applicaster 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0a3317532707cf06cf526f9fd1415f42192319
-  data.tar.gz: 5d82821d7a9f287c4323992430277ce271eba424
+  metadata.gz: c557d14bae9ae9c5e9f67d0008d5375ac694ccd1
+  data.tar.gz: a434435c67e5391ed860c91f7e654d110fc62755
 SHA512:
-  metadata.gz: bb5b8fbcdad31b8183625d25720d07645eacc6bc17a67147ad9d7238665e3dab674a9d25166a428525bdfb19e529624d3b8cc5e7fc5bf58529c472acc589e08b
-  data.tar.gz: 044fd3eade0aba820f4ef97b91bf1b2b5dd1492d04f81e267b8c859dc531a4360f38d87eaa4c72559cc08684fb65933a42d101cfa25f75db6e60d9baaa3ab6f3
+  metadata.gz: 4e1b369b1647364acf5c804a51c926abb9cd811ba6704e9580dc3c54aedac3a6bec9ec6072812adab7c2ee103680ab44f2a36e323a624474d2a1c35e3b977634
+  data.tar.gz: 5dffb8080ed50ced4bc38a107752ac7c0d09635a7e6d9593af295b054047cec3d1859329bd77d5c94a734629142a6d95bc9213bfa4ded7ca2c232ffbdbbfbbfc

data/README.md

@@ -13,29 +13,27 @@ gem 'omniauth-applicaster'
 
 ## Usage
 
-### Configuration
-
-The OAuth client ID and client secret are read from the environment variables
-`ACCOUNTS_CLIENT_ID` and `ACCOUNTS_CLIENT_SECRET` respectivly.
+### Omniauth strategy in Rails
 
-The gem uses `https://accounts2.applicaster.com` as the site's endpoint by
-default to change this set the `ACCOUNTS_BASE_URL` environment variable. This is
-useful for example when running a local version of the accounts service
+See [Omniauth](https://github.com/intridea/omniauth) for setting up omniauth.
 
-### Omniauth strategy
+```ruby
+# config/initializers/applicaster.rb
 
-See [Omniauth](https://github.com/intridea/omniauth) for setting up omniauth.
+Applicaster::Accounts.configure do |config|
+  config.client_id = "my-service-uid"
+  config.client_secret = "my-service-secret"
 
-In Rails, you will need something along the lines of:
+  #use local accounts service with Pow when in development
+  config.base_url = "http://accounts2.dev/" if Rails.env.development?
+end
+```
 
 ```ruby
-ENV["ACCOUNTS_CLIENT_ID"] = "my-service-uid"
-ENV["ACCOUNTS_CLIENT_SECRET"] = "my-service-secret"
+# config/initializers/omniauth.rb
 
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :applicaster,
-    ENV["ACCOUNTS_CLIENT_ID"],
-    ENV["ACCOUNTS_CLIENT_SECRET"]
+  provider :applicaster
 end
 ```
 
@@ -67,6 +65,21 @@ MyApp::Application.routes.draw do
 end
 ```
 
+### Configuration
+
+For the possible configuration options please see
+[Applicaster::Accounts::Configuration](lib/applicaster/accounts/configuration.rb)
+
+If not provided via the configuration block, the OAuth client ID and client
+secret are read from the environment variables `ACCOUNTS_CLIENT_ID` and
+`ACCOUNTS_CLIENT_SECRET` respectivly.
+
+The gem uses `https://accounts2.applicaster.com` as the site's endpoint by
+default to change this use the `base_url` config option or set the
+`ACCOUNTS_BASE_URL` environment variable. This is useful for example when
+running a local version of the accounts service
+
+
 ### Accounts SDK
 
 #### List all available accounts
@@ -83,7 +96,7 @@ end
 
 ```ruby
 user = Applicaster::Accounts.user_from_token(access_token)
-# user is an Applicaster::Accounts::User instnce
+# user is an Applicaster::Accounts::User instance
 ```
 
 ## Contributing

data/lib/applicaster/accounts.rb

@@ -6,37 +6,33 @@ module Applicaster
   class Accounts
     autoload :Account, "applicaster/accounts/account"
     autoload :User, "applicaster/accounts/user"
+    autoload :Configuration, "applicaster/accounts/configuration"
 
     RETRYABLE_STATUS_CODES = [500, 503, 502]
-    FARADAY_TIMEOUT = 0.5
-
-    attr_accessor :client_id
-    attr_accessor :client_secret
 
     class << self
-      def default_site
-        "https://accounts2.applicaster.com"
-      end
-
-      def site
-        URI.parse(ENV["ACCOUNTS_BASE_URL"] || default_site)
-      end
-
       def connection(options = {})
-        Faraday.new(url: site, request: { timeout: FARADAY_TIMEOUT } ) do |conn|
+        conn_opts = {
+          url: config.base_url,
+          request: { timeout: config.timeout }
+        }
+
+        Faraday.new(conn_opts) do |conn|
           if options[:token]
             conn.request :oauth2, options[:token]
           end
 
           conn.request :json
           conn.request :retry,
+            max: config.retries,
             interval: 0.05,
             backoff_factor: 2,
             exceptions: [Faraday::ClientError, Faraday::TimeoutError],
             methods: [],
             retry_if: -> (env, exception) {
               env[:method] == :get &&
-              RETRYABLE_STATUS_CODES.include?(env[:status])
+                (exception.is_a?(Faraday::TimeoutError) ||
+                 RETRYABLE_STATUS_CODES.include?(env[:status]))
             }
 
 
@@ -59,14 +55,26 @@ module Applicaster
         if e.response[:status] == 401
           nil
         else
-          raise e
+          raise
         end
       end
-    end
 
-    def initialize(client_id = nil, client_secret = nil)
-      @client_id = client_id || ENV["ACCOUNTS_CLIENT_ID"]
-      @client_secret = client_secret || ENV["ACCOUNTS_CLIENT_SECRET"]
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def oauth_client(config = config)
+        ::OAuth2::Client.new(
+          config.client_id,
+          config.client_secret,
+          site: config.base_url,
+          authorize_url: "/oauth/authorize",
+        )
+      end
     end
 
     def user_data_from_omniauth(omniauth_credentials)
@@ -87,24 +95,9 @@ module Applicaster
     protected
 
     def client_credentials_token
-      @client_credentials_token ||= client.client_credentials.get_token
-    end
-
-    def client
-      @client ||= ::OAuth2::Client.new(
-        client_id,
-        client_secret,
-        site: Applicaster::Accounts.site,
-        authorize_url: "/oauth/authorize",
-      )
-    end
-
-    def access_token(omniauth_credentials)
-      @access_token ||= OAuth2::AccessToken.new(
-        client,
-        omniauth_credentials["token"],
-        omniauth_credentials.except("token", "expires"),
-      )
+      @client_credentials_token ||= self.class.oauth_client
+        .client_credentials
+        .get_token
     end
   end
 end

data/lib/applicaster/accounts/configuration.rb

@@ -0,0 +1,32 @@
+module Applicaster
+  class Accounts
+    class Configuration
+      include Virtus.model
+
+      # The base URL of the accounts service
+      attribute :base_url, String,
+        default: :default_base_url
+
+      # OAuth2 provider client ID
+      attribute :client_id, String,
+        default: proc { ENV["ACCOUNTS_CLIENT_ID"] }
+
+      # OAuth2 provider client secret
+      attribute :client_secret, String,
+        default: proc { ENV["ACCOUNTS_CLIENT_SECRET"] }
+
+      # Number of times to retry safe requests
+      attribute :retries, Integer,
+        default: 2
+
+      # Number of seconds before a request will be timed out
+      attribute :timeout, Float,
+        default: 1
+
+
+      def default_base_url
+        ENV["ACCOUNTS_BASE_URL"] || "https://accounts2.applicaster.com/"
+      end
+    end
+  end
+end

data/lib/omniauth-applicaster/version.rb

@@ -1,5 +1,5 @@
-module Omniauth
+module OmniAuth
   module Applicaster
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

data/lib/omniauth/strategies/applicaster.rb

@@ -24,12 +24,7 @@ module OmniAuth
       end
 
       def client
-        ::OAuth2::Client.new(
-          options.client_id,
-          options.client_secret,
-          site: ::Applicaster::Accounts.site,
-          authorize_url: "/oauth/authorize",
-        )
+        ::Applicaster::Accounts.oauth_client
       end
     end
   end

data/omniauth-applicaster.gemspec

@@ -5,7 +5,7 @@ require 'omniauth-applicaster/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "omniauth-applicaster"
-  spec.version       = Omniauth::Applicaster::VERSION
+  spec.version       = OmniAuth::Applicaster::VERSION
   spec.authors       = ["Neer Friedman"]
   spec.email         = ["neerfri@gmail.com"]
   spec.summary       = %q{Omniauth strategy for http://accounts.applicaster.com}

data/spec/lib/applicaster/accounts/configuration_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe Applicaster::Accounts::Configuration do
+  let(:config) { described_class.new }
+
+  specify "defaults" do
+    expect(config.attributes).to eq({
+      base_url: "https://accounts2.applicaster.com/",
+      client_id: nil,
+      client_secret: nil,
+      retries: 2,
+      timeout: 1.0,
+    })
+  end
+
+  describe "#base_url" do
+    it "defaults to env var ACCOUNTS_BASE_URL" do
+      base_url = "http://example.com"
+
+      with_env_var("ACCOUNTS_BASE_URL", base_url) do
+        expect(config.base_url).to eq(base_url)
+      end
+    end
+  end
+
+  describe "#client_id" do
+    it "defaults to env var ACCOUNTS_CLIENT_ID" do
+      with_env_var("ACCOUNTS_CLIENT_ID", "test-client-id") do
+        expect(config.client_id).to eq("test-client-id")
+      end
+    end
+  end
+
+  describe "#client_secret" do
+    it "defaults to env var ACCOUNTS_CLIENT_SECRET" do
+      with_env_var("ACCOUNTS_CLIENT_SECRET", "test-client-secret") do
+        expect(config.client_secret).to eq("test-client-secret")
+      end
+    end
+  end
+end

data/spec/lib/applicaster/accounts_spec.rb

@@ -7,32 +7,6 @@ RSpec.describe Applicaster::Accounts do
     end
   end
 
-  describe ".site" do
-    it "returns a URI object" do
-      expect(return_value).to be_kind_of(URI)
-    end
-
-    it "returns https://accounts2.applicaster.com" do
-      expect(return_value.to_s).to eq("https://accounts2.applicaster.com")
-    end
-
-    context "when ACCOUNTS_BASE_URL is set" do
-      around do |example|
-        with_base_url("http://example.com") do
-          example.run
-        end
-      end
-
-      it "returns http://example.com" do
-        expect(return_value.to_s).to eq("http://example.com")
-      end
-    end
-
-    def return_value
-      Applicaster::Accounts.site
-    end
-  end
-
   describe ".connection" do
     let(:remote_url) { "https://accounts2.applicaster.com/test.json" }
     let(:request_stub) { stub_request(:get, remote_url) }
@@ -63,22 +37,29 @@ RSpec.describe Applicaster::Accounts do
     end
 
     context "when server is not responding" do
-      around do |example|
-        with_base_url("http://localhost:6969") do
-          WebMock.allow_net_connect!
-          example.run
-          WebMock.disable_net_connect!
-        end
-      end
+      let(:timeout) { 0.1 }
+      let(:retries) { 1 }
+      let(:max_exec_time) { 1 + timeout + (timeout + 0.05) * retries }
 
       before do
         @server = TCPServer.new(6969)
+
+        Applicaster::Accounts.configure do |config|
+          config.base_url = "http://localhost:6969"
+          config.timeout = timeout
+          config.retries = retries
+        end
       end
 
-      it "times out after 0.5 second with 2 retries" do
-        expect {
-          connection.get("/test.json") rescue nil
-        }.to change { Time.now }.by(a_value < 1.5)
+      it "times out after 0.1 second with 1 retry" do
+        disable_webmock do
+          expect {
+            begin
+              connection.get("/test.json")
+            rescue Faraday::TimeoutError
+            end
+          }.to change { Time.now }.by(a_value < max_exec_time)
+        end
       end
     end
 
@@ -111,17 +92,27 @@ RSpec.describe Applicaster::Accounts do
     end
   end
 
-  describe "#initialize" do
-    it "accepts client_id and client_secret" do
-      service = Applicaster::Accounts.new("my_client_id", "my_client_secret")
+  describe ".config" do
+    it "returns an Applicaster::Accounts::Configuration" do
+      expect(config).to be_kind_of(Applicaster::Accounts::Configuration)
+    end
 
-      expect(service.client_id).to eq("my_client_id")
-      expect(service.client_secret).to eq("my_client_secret")
+    def config
+      Applicaster::Accounts.config
     end
+  end
 
-    it "takes default values from ENV vars" do
-      expect(accounts_service.client_id).to eq("client_id")
-      expect(accounts_service.client_secret).to eq("client_secret")
+  describe ".configure" do
+    it "yields with Applicaster::Accounts.config" do
+      expect { |b| configure(&b) }.to yield_with_args(config)
+    end
+
+    def configure(&block)
+      Applicaster::Accounts.configure(&block)
+    end
+
+    def config
+      Applicaster::Accounts.config
     end
   end
 
@@ -160,10 +151,4 @@ RSpec.describe Applicaster::Accounts do
       ]
     end
   end
-
-  def with_base_url(url)
-    value_bofre, ENV["ACCOUNTS_BASE_URL"] = ENV["ACCOUNTS_BASE_URL"], url
-    yield
-    ENV["ACCOUNTS_BASE_URL"] = value_bofre
-  end
 end

data/spec/support/env_variable_helper.rb

@@ -0,0 +1,13 @@
+module EnvVariableHelper
+  RSpec.configure do |config|
+    config.include self
+  end
+
+  def with_env_var(name, value)
+    value_bofre, ENV[name] = ENV[name], value
+    yield
+    ENV[name] = value_bofre
+  end
+end
+
+

data/spec/support/set_test_configuration.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before do
+    Applicaster::Accounts.instance_variable_set(:@config, nil)
+    Applicaster::Accounts.configure do |config|
+      config.client_id = "client-id"
+      config.client_secret = "client-secret"
+    end
+  end
+end

data/spec/support/webmock_stubs_helper.rb

@@ -3,8 +3,14 @@ module WebmockStubsHelper
     config.include self
   end
 
+  def disable_webmock
+    WebMock.allow_net_connect!
+    yield
+    WebMock.disable_net_connect!
+  end
+
   def stub_client_credentials_request
-    stub_request(:post, "https://client_id:client_secret@#{accounts_host}/oauth/token")
+    stub_request(:post, "https://client-id:client-secret@#{accounts_host}/oauth/token")
       .with(:body => {"grant_type"=>"client_credentials"})
       .to_return(successful_json_response(access_token: "client-credentials-token"))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-applicaster
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Neer Friedman
@@ -137,6 +137,7 @@ files:
 - Rakefile
 - lib/applicaster/accounts.rb
 - lib/applicaster/accounts/account.rb
+- lib/applicaster/accounts/configuration.rb
 - lib/applicaster/accounts/user.rb
 - lib/applicaster/auth_helpers.rb
 - lib/applicaster/sessions_controller_mixin.rb
@@ -145,11 +146,13 @@ files:
 - lib/omniauth/strategies/applicaster.rb
 - omniauth-applicaster.gemspec
 - spec/lib/applicaster/accounts/account_spec.rb
+- spec/lib/applicaster/accounts/configuration_spec.rb
 - spec/lib/applicaster/accounts_spec.rb
 - spec/lib/applicaster/auth_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_controller.rb
-- spec/support/setup_env_vars.rb
+- spec/support/env_variable_helper.rb
+- spec/support/set_test_configuration.rb
 - spec/support/webmock_stubs_helper.rb
 homepage: ''
 licenses:
@@ -177,9 +180,11 @@ specification_version: 4
 summary: Omniauth strategy for http://accounts.applicaster.com
 test_files:
 - spec/lib/applicaster/accounts/account_spec.rb
+- spec/lib/applicaster/accounts/configuration_spec.rb
 - spec/lib/applicaster/accounts_spec.rb
 - spec/lib/applicaster/auth_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_controller.rb
-- spec/support/setup_env_vars.rb
+- spec/support/env_variable_helper.rb
+- spec/support/set_test_configuration.rb
 - spec/support/webmock_stubs_helper.rb

data/spec/support/setup_env_vars.rb

@@ -1,2 +0,0 @@
-ENV["ACCOUNTS_CLIENT_ID"] = "client_id"
-ENV["ACCOUNTS_CLIENT_SECRET"] = "client_secret"