omniauth-applicaster 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6dac00d1b72d155eb6e5743ee7d3012c40509e0
-  data.tar.gz: 2870ad6f84ea82b2cc34e988bd25fb645ce60018
+  metadata.gz: e551c14cc83eda398d5b50f875d69449addcb08d
+  data.tar.gz: 527028283f9b204b66e53925d91350ead8c19cec
 SHA512:
-  metadata.gz: 7a6a8c3a3aa7c833285b336322f7f67c32f683c85401d75e282f5b3c9ca0ab2d5bcc5275c505fb698b39e486269e2eb97b17b97f1442431b0e52069b943908bd
-  data.tar.gz: a324dc3dd511666a353158893d28da3314d2d6df28f460c54fb428eaf1ae084a022eb0cf7e15091b73cd22bfb3868c049089488cc9f0188c38fe4f366a8cc380
+  metadata.gz: 8e65beba13fd06bea78988069a4cbaf872a492da5941cbda4ea52795e6c95717378bd1895a096b2c338fdba1962c7ffd86d641cfe3f29e3ba13a4dcec17be3ae
+  data.tar.gz: 06349a9fab30e5a1a31fdbacd10f338534fd39343c9e834ece3f22126ea7361b55ddf7c1cc2191ca9935e2d3e3dfd5d8563170cc5a5f5ab8be81d8a370a67c8f

data/README.md

@@ -111,6 +111,31 @@ accounts = Applicaster::Accounts.accounts_from_token(access_token)
 # accounts is an array of `Applicaster::Accounts::User` objects
 ```
 
+
+### Testing your app
+
+The library contains helpers to make functional tests easier
+
+In `spec/spec_helper.rb` add:
+```ruby
+RSpec.configure do |config|
+  config.include Applicaster::Test::Accounts::WebMockHelper
+end
+```
+
+You can use `accounts_mock_data` to access the fake data, for example:
+`accounts_mock_data.all_accounts_attributes.first`
+
+in example groups that use the client_credentials flow use:
+```ruby
+before do
+  stub_client_credentials_request
+  stub_accounts_index_response(token: client_credentials_token)
+end
+```
+
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/omniauth-applicaster/fork )

data/lib/applicaster/test.rb

@@ -0,0 +1,18 @@
+module Applicaster
+  module Test
+    module Accounts
+      autoload :MockData, "applicaster/test/accounts/mock_data"
+      autoload :WebMockHelper, "applicaster/test/accounts/web_mock_helper"
+    end
+
+    module_function
+    def inc_sequence
+      @sequence ||= 0
+      @sequence += 1
+    end
+
+    def generate_object_id(sequence = inc_sequence)
+      sprintf("11223344%016d", sequence)
+    end
+  end
+end

data/lib/applicaster/test/accounts/mock_data.rb

@@ -0,0 +1,19 @@
+module Applicaster
+  module Test
+    module Accounts
+      class MockData
+        def all_accounts_attributes
+          @all_accounts_attributes ||= (1..2).map do |i|
+            sequence = Test.inc_sequence
+            id = Test.generate_object_id(sequence)
+            {
+              id: id,
+              name: "Test Account #{sequence}",
+              old_id: id,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/applicaster/test/accounts/web_mock_helper.rb

@@ -0,0 +1,54 @@
+begin
+  require "webmock/rspec"
+rescue NameError
+  warn "webmock is not installed."
+  warn "Applicaster::Test::Accounts::WebMockHelper uses webmock to setup stubs."
+end
+
+module Applicaster
+  module Test
+    module Accounts
+      module WebMockHelper
+        def stub_accounts_index_response(options = {})
+          accounts = options[:accounts] || accounts_mock_data.all_accounts_attributes
+
+          stub_request(:get, accounts_base_url.join("/api/v1/accounts.json"))
+            .with(query: { access_token: options[:token] })
+            .to_return(successful_json_response(accounts))
+        end
+
+        def stub_client_credentials_request
+          url = accounts_base_url.join("/oauth/token")
+          url.user = Applicaster::Accounts.config.client_id
+          url.password = Applicaster::Accounts.config.client_secret
+
+          stub_request(:post, url)
+            .with(body: { "grant_type" => "client_credentials" })
+            .to_return(successful_json_response(access_token: client_credentials_token))
+        end
+
+        def accounts_mock_data
+          @accounts_mock_data ||= Test::Accounts::MockData.new
+        end
+
+        def client_credentials_token
+          "client-credentials-token"
+        end
+
+        private
+
+        def successful_json_response(body)
+          {
+            status: 200,
+            body: body.to_json,
+            headers: { "Content-Type" => "application/json" },
+          }
+        end
+
+        def accounts_base_url
+          Addressable::URI.parse(Applicaster::Accounts.config.base_url)
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-applicaster.rb

@@ -2,4 +2,5 @@ require "omniauth-applicaster/version"
 require "applicaster/accounts"
 require "applicaster/auth_helpers"
 require "applicaster/sessions_controller_mixin"
+require "applicaster/test"
 require 'omniauth/strategies/applicaster'

data/lib/omniauth-applicaster/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Applicaster
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/spec/lib/applicaster/test/accounts/mock_data_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+RSpec.describe Applicaster::Test::Accounts::MockData do
+  subject(:mock_data) { described_class.new }
+
+  describe "#all_accounts_attributes" do
+    it "has 2 elements" do
+      expect(mock_data.all_accounts_attributes.size).to eq(2)
+    end
+
+    describe "returned account" do
+      subject(:account) { mock_data.all_accounts_attributes.first }
+      let(:id_regexp) { /^11223344\d{16}$/ }
+
+      it { is_expected.to include(id: id_regexp) }
+      it { is_expected.to include(old_id: id_regexp) }
+      it { is_expected.to include(name: /Test Account \d+/) }
+    end
+  end
+end

data/spec/lib/applicaster/test/accounts/webmock_helper_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe Applicaster::Test::Accounts::WebMockHelper do
+  let(:including_class) { Class.new { include(Applicaster::Test::Accounts::WebMockHelper) } }
+  subject(:instace) { including_class.new }
+
+  it { is_expected.to respond_to(:stub_accounts_index_response) }
+  it { is_expected.to respond_to(:stub_client_credentials_request) }
+  it { is_expected.to respond_to(:accounts_mock_data) }
+  it { is_expected.to respond_to(:client_credentials_token) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-applicaster
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Neer Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,9 @@ files:
 - lib/applicaster/accounts/user.rb
 - lib/applicaster/auth_helpers.rb
 - lib/applicaster/sessions_controller_mixin.rb
+- lib/applicaster/test.rb
+- lib/applicaster/test/accounts/mock_data.rb
+- lib/applicaster/test/accounts/web_mock_helper.rb
 - lib/omniauth-applicaster.rb
 - lib/omniauth-applicaster/version.rb
 - lib/omniauth/strategies/applicaster.rb
@@ -150,6 +153,8 @@ files:
 - spec/lib/applicaster/accounts/configuration_spec.rb
 - spec/lib/applicaster/accounts_spec.rb
 - spec/lib/applicaster/auth_helpers_spec.rb
+- spec/lib/applicaster/test/accounts/mock_data_spec.rb
+- spec/lib/applicaster/test/accounts/webmock_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_controller.rb
 - spec/support/env_variable_helper.rb
@@ -184,6 +189,8 @@ test_files:
 - spec/lib/applicaster/accounts/configuration_spec.rb
 - spec/lib/applicaster/accounts_spec.rb
 - spec/lib/applicaster/auth_helpers_spec.rb
+- spec/lib/applicaster/test/accounts/mock_data_spec.rb
+- spec/lib/applicaster/test/accounts/webmock_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_controller.rb
 - spec/support/env_variable_helper.rb