tokyo_api 1.3.0 → 1.6.0

data/spec/client_spec.rb

@@ -1,16 +1,28 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
 
-describe TokyoApi::Client do
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
 
-  describe "instantiated" do
+describe TokyoApi::Client do
+  describe 'initialisation' do
     subject { described_class.new(options) }
 
-    context 'process_basic_auth' do
-      let(:options) { { :basic_auth => 'login:password' } }
-      let(:config) { subject.connection.configuration  }
-      specify { expect(config.username).to eq 'login' }
-      specify { expect(config.password).to eq 'password' }
+    context 'with a basic_auth string parameter' do
+      let(:options) { { basic_auth: 'login:password' } }
+
+      it 'should set username/password on the configuration' do
+        config = subject.connection.configuration
+        expect(config.username).to eq 'login'
+        expect(config.password).to eq 'password'
+      end
     end
 
+    context 'with a timeout' do
+      let(:options) { { timeout: 5 } }
+
+      it 'should set the timeout on the faraday options' do
+        config = subject.connection.configuration
+        expect(config.faraday_options[:request][:timeout]).to eq 5
+      end
+    end
   end
-end
+end

data/spec/expire_spec.rb

@@ -1,4 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
 
 describe TokyoApi::Expire do
   subject { TokyoApi.new(host: 'test.com') }
@@ -8,16 +10,16 @@ describe TokyoApi::Expire do
     let(:request_path) { '/expire/organisation/foo.com' }
 
     before(:each) do
-     stub_get(request_path).to_return(:body => body, :status => status,
-                                     :headers => { content_type: "application/json; charset=utf-8"})
+      stub_get(request_path).to_return(body: body, status: status,
+                                       headers: { content_type: 'application/json; charset=utf-8' })
     end
 
     describe 'success' do
-      let(:status) { 200 }  
+      let(:status) { 200 }
 
       it 'should find an organisation' do
-        expect(subject.expire.organisation('foo.com')).to eq({'status' => 'success'})
+        expect(subject.expire.organisation('foo.com')).to eq({ 'status' => 'success' })
       end
     end
   end
-end
+end

data/spec/identity_spec.rb

@@ -1,4 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
 
 describe TokyoApi::Identity do
   subject { TokyoApi.new(host: 'test.com') }
@@ -15,15 +17,15 @@ describe TokyoApi::Identity do
     let(:status) { 200 }
 
     before(:each) do
-      stub_get(request_path).to_return(:body => body, :status => status,
-                                       :headers => { content_type: "application/json; charset=utf-8"})
+      stub_get(request_path).to_return(body: body, status: status,
+                                       headers: { content_type: 'application/json; charset=utf-8' })
     end
 
     describe 'error' do
       let(:body) { fixture('responses/full_user_error') }
 
       it 'should return an error hash' do
-        expect(subject.identity.full_user('1')).to eq({'error' => 'Connection refused'})
+        expect(subject.identity.full_user('1')).to eq({ 'error' => 'Connection refused' })
       end
     end
 
@@ -31,8 +33,8 @@ describe TokyoApi::Identity do
       let(:body) { fixture('responses/identity/full_user_success') }
 
       it 'should return a hash' do
-        expect(subject.identity.full_user('1')).to eq({'first_name' => 'Homer', 'last_name' => 'Simpson',
-                                                       'country' => 'GB', 'postal' => '12345', 'email' => 'foo@bar.com' })
+        expect(subject.identity.full_user('1')).to eq({ 'first_name' => 'Homer', 'last_name' => 'Simpson',
+                                                        'country' => 'GB', 'postal' => '12345', 'email' => 'foo@bar.com' })
       end
     end
   end
@@ -46,52 +48,60 @@ describe TokyoApi::Identity do
 
     context 'with required_fields' do
       it 'should return rooted relative path to tokyo user API endpoint' do
-        expect(subject.identity.tokyo_identity_user_path('-123456', required_fields: [:first_name, :last_name, :email, :postal, :phone])).to eq('/identity/user/-123456?required_fields=first_name,last_name,email,postal,phone')
+        expect(subject.identity.tokyo_identity_user_path('-123456',
+                                                         required_fields: %i[first_name last_name email postal
+                                                                             phone])).to eq('/identity/user/-123456?required_fields=first_name,last_name,email,postal,phone')
       end
 
       it 'should url-escape field names with weird characters' do
-        expect(subject.identity.tokyo_identity_user_path('-123456', required_fields: ['email', 'fish & chips'])).to eq('/identity/user/-123456?required_fields=email,fish+%26+chips')
+        expect(subject.identity.tokyo_identity_user_path('-123456',
+                                                         required_fields: ['email',
+                                                                           'fish & chips'])).to eq('/identity/user/-123456?required_fields=email,fish+%26+chips')
       end
     end
 
     context 'with_subscription_status and associated arguments' do
       it 'should not include query string parameter if argument is missing' do
-        expect(subject.identity.tokyo_identity_user_path('123abc456')).not_to match /.+with_subscription_status=.+/
+        expect(subject.identity.tokyo_identity_user_path('123abc456')).not_to match(/.+with_subscription_status=.+/)
       end
 
       it 'should not include query string parameter if argument is false' do
-        expect(subject.identity.tokyo_identity_user_path('123abc456', with_subscription_status: false)).not_to match /.+with_subscription_status=.+/
+        expect(subject.identity.tokyo_identity_user_path('123abc456',
+                                                         with_subscription_status: false)).not_to match(/.+with_subscription_status=.+/)
       end
 
       it 'should not include opt_in_public_ids and minimum_consent_level if with_subscription_status is false' do
         tokyo_path = subject.identity.tokyo_identity_user_path('123abc456',
-                                                                with_subscription_status: false,
-                                                                opt_in_public_ids: ['policy-1.5'],
-                                                                minimum_consent_level: 'explicit')
+                                                               with_subscription_status: false,
+                                                               opt_in_public_ids: ['policy-1.5'],
+                                                               minimum_consent_level: 'explicit')
 
-        expect(tokyo_path).not_to match /.+opt_in_public_ids=.+/
-        expect(tokyo_path).not_to match /.+minimum_consent_level=.+/
+        expect(tokyo_path).not_to match(/.+opt_in_public_ids=.+/)
+        expect(tokyo_path).not_to match(/.+minimum_consent_level=.+/)
       end
 
       it 'should include query string parameter if argument is true' do
-        expect(subject.identity.tokyo_identity_user_path('123abc456', with_subscription_status: true)).to match /.+with_subscription_status=.+/
+        expect(subject.identity.tokyo_identity_user_path('123abc456',
+                                                         with_subscription_status: true)).to match(/.+with_subscription_status=.+/)
       end
 
       it 'should include encrypted parameter if argument is true' do
-        expect(subject.identity.tokyo_identity_user_path('123abc456', with_subscription_status: true, encrypted: true)).to match /.+encrypted=.+/
+        expect(subject.identity.tokyo_identity_user_path('123abc456', with_subscription_status: true,
+                                                                      encrypted: true)).to match(/.+encrypted=.+/)
       end
 
       it 'should include opt_in_public_ids and minimum_consent_level if with_subscription_status is true' do
         tokyo_path = subject.identity.tokyo_identity_user_path('123abc456',
-                                                                required_fields: [:first_name, :last_name, :email, :postal, :phone],
-                                                                with_subscription_status: true,
-                                                                opt_in_public_ids: ['policy-1.5'],
-                                                                minimum_consent_level: 'explicit')
-
-        expect(tokyo_path).to match /.+with_subscription_status=true.*/
-        expect(tokyo_path).to match /.+opt_in_public_ids=.+/
-        expect(tokyo_path).to match /.+minimum_consent_level=.+/
-        expect { URI::parse(tokyo_path) }.not_to raise_error
+                                                               required_fields: %i[first_name last_name email
+                                                                                   postal phone],
+                                                               with_subscription_status: true,
+                                                               opt_in_public_ids: ['policy-1.5'],
+                                                               minimum_consent_level: 'explicit')
+
+        expect(tokyo_path).to match(/.+with_subscription_status=true.*/)
+        expect(tokyo_path).to match(/.+opt_in_public_ids=.+/)
+        expect(tokyo_path).to match(/.+minimum_consent_level=.+/)
+        expect { URI.parse(tokyo_path) }.not_to raise_error
       end
     end
   end
@@ -103,17 +113,21 @@ describe TokyoApi::Identity do
 
     it 'should return correct path for a list of public ids' do
       expected_path = '/identity/subscription_status/abc123?opt_in_public_ids=policy-1.5%2Cpolicy-1.6'
-      expect(subject.identity.subscription_status_path('abc123', opt_in_public_ids: ['policy-1.5', 'policy-1.6'])).to eq expected_path
+      expect(subject.identity.subscription_status_path('abc123',
+                                                       opt_in_public_ids: ['policy-1.5',
+                                                                           'policy-1.6'])).to eq expected_path
     end
 
     it 'should support minimum_consent_level' do
       expected_path = '/identity/subscription_status/abc123?opt_in_public_ids=policy-1.5&minimum_consent_level=explicit'
-      expect(subject.identity.subscription_status_path('abc123', opt_in_public_ids: ['policy-1.5'], minimum_consent_level: 'explicit')).to eq expected_path
+      expect(subject.identity.subscription_status_path('abc123', opt_in_public_ids: ['policy-1.5'],
+                                                                 minimum_consent_level: 'explicit')).to eq expected_path
     end
 
     it 'should support encrypted param' do
       expected_path = '/identity/subscription_status/abc123?opt_in_public_ids=policy-1.5&minimum_consent_level=explicit&encrypted=1'
-      expect(subject.identity.subscription_status_path('abc123', opt_in_public_ids: ['policy-1.5'], minimum_consent_level: 'explicit', encrypted: true)).to eq expected_path
+      expect(subject.identity.subscription_status_path('abc123', opt_in_public_ids: ['policy-1.5'],
+                                                                 minimum_consent_level: 'explicit', encrypted: true)).to eq expected_path
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
@@ -6,12 +8,12 @@ require 'tokyo_api'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.include WebMock::API
   config.color = true
-  #config.raise_errors_for_deprecations!
+  # config.raise_errors_for_deprecations!
 end
 
 def stub_get(path)
@@ -29,7 +31,7 @@ def stub_tokyo_request(method, path)
 end
 
 def fixture_path
-  File.expand_path("../fixtures", __FILE__)
+  File.expand_path('fixtures', __dir__)
 end
 
 def fixture(file)

data/spec/tokyo_api_spec.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
 
 describe TokyoApi do
   before(:each) do
     allow(TokyoApi::Client).to receive(:setup_client)
   end
   specify { expect(subject).to respond_to :actionkit }
-  specify { expect(subject.new).to be_a(TokyoApi::Client)}
+  specify { expect(subject.new).to be_a(TokyoApi::Client) }
 end
-
-

data/tokyo_api.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: tokyo_api 1.3.0 ruby lib
+# stub: tokyo_api 1.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tokyo_api".freeze
-  s.version = "1.3.0"
+  s.version = "1.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Nathan Woodhull".freeze]
-  s.date = "2018-09-04"
+  s.date = "2021-03-24"
   s.description = "Tokyo is a CRM middleware, this gem helps apps talk to it.".freeze
   s.email = "nathan@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
     ".ruby-version",
     ".travis.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -34,61 +33,59 @@ Gem::Specification.new do |s|
     "lib/tokyo_api.rb",
     "lib/tokyo_api/actionkit.rb",
     "lib/tokyo_api/base.rb",
-    "lib/tokyo_api/bluestatedigital.rb",
     "lib/tokyo_api/campact.rb",
     "lib/tokyo_api/client.rb",
     "lib/tokyo_api/expire.rb",
     "lib/tokyo_api/identity.rb",
-    "lib/tokyo_api/krautbuster.rb",
     "spec/actionkit_spec.rb",
-    "spec/bluestatedigital_spec.rb",
     "spec/campact_spec.rb",
     "spec/client_spec.rb",
     "spec/expire_spec.rb",
     "spec/fixtures/expire/success",
     "spec/fixtures/responses/actionkit/full_user_success",
-    "spec/fixtures/responses/bluestatedigital/full_user_success",
     "spec/fixtures/responses/campact/full_user_success",
     "spec/fixtures/responses/full_user_error",
     "spec/fixtures/responses/full_user_success",
     "spec/fixtures/responses/identity/full_user_success",
     "spec/fixtures/responses/krautbuster/full_user_success",
     "spec/identity_spec.rb",
-    "spec/krautbuster_spec.rb",
     "spec/spec_helper.rb",
     "spec/tokyo_api_spec.rb",
     "tokyo_api.gemspec"
   ]
   s.homepage = "http://github.com/controlshift/tokyo_api".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.6".freeze
+  s.rubygems_version = "3.0.8".freeze
   s.summary = "Ruby API Wrapper for Tokyo CRM service".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<vertebrae>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
-      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<vertebrae>.freeze, [">= 0.6.0"])
       s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
       s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
+      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<vertebrae>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<webmock>.freeze, [">= 0"])
-      s.add_dependency(%q<byebug>.freeze, [">= 0"])
+      s.add_dependency(%q<vertebrae>.freeze, [">= 0.6.0"])
       s.add_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_dependency(%q<byebug>.freeze, [">= 0"])
       s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+      s.add_dependency(%q<webmock>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<vertebrae>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<webmock>.freeze, [">= 0"])
-    s.add_dependency(%q<byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<vertebrae>.freeze, [">= 0.6.0"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
+    s.add_dependency(%q<webmock>.freeze, [">= 0"])
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokyo_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Nathan Woodhull
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -16,16 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: juwelier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +122,6 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -117,27 +130,22 @@ files:
 - lib/tokyo_api.rb
 - lib/tokyo_api/actionkit.rb
 - lib/tokyo_api/base.rb
-- lib/tokyo_api/bluestatedigital.rb
 - lib/tokyo_api/campact.rb
 - lib/tokyo_api/client.rb
 - lib/tokyo_api/expire.rb
 - lib/tokyo_api/identity.rb
-- lib/tokyo_api/krautbuster.rb
 - spec/actionkit_spec.rb
-- spec/bluestatedigital_spec.rb
 - spec/campact_spec.rb
 - spec/client_spec.rb
 - spec/expire_spec.rb
 - spec/fixtures/expire/success
 - spec/fixtures/responses/actionkit/full_user_success
-- spec/fixtures/responses/bluestatedigital/full_user_success
 - spec/fixtures/responses/campact/full_user_success
 - spec/fixtures/responses/full_user_error
 - spec/fixtures/responses/full_user_success
 - spec/fixtures/responses/identity/full_user_success
 - spec/fixtures/responses/krautbuster/full_user_success
 - spec/identity_spec.rb
-- spec/krautbuster_spec.rb
 - spec/spec_helper.rb
 - spec/tokyo_api_spec.rb
 - tokyo_api.gemspec
@@ -145,7 +153,7 @@ homepage: http://github.com/controlshift/tokyo_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,9 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby API Wrapper for Tokyo CRM service
 test_files: []