tokyo_api 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af1abab30e5fd562a76150009f4e942472e6a201ec92f28123a6cf3e4c5e1035
-  data.tar.gz: 53965d4edd39431e61fc4024f9e0228a53c2753129645961856612adaa3a6ef5
+  metadata.gz: 608376ec5c22df615936ab9c5603877f983e3f1c36c93071f3e4e4195bc6012e
+  data.tar.gz: 48218037c0aa31d24ca5f708311677387172422adc63a1ee5a0f190b3f92bfd2
 SHA512:
-  metadata.gz: f9cc2b5e986da3e50938638fcb014771dd22a9f95033625999a187e011c5140f44db98fb231a15859beb7318cc17a68be9ee757539c1c47a009b71fe564b7a3e
-  data.tar.gz: a25c4dc8fb03616a16b1b7f08c2a8a79479c3630b05b5a5348af667b5ec3a527622da6c9f37063e65ff40f50f21c162f8445d891f79b1a2601d29363e33131ff
+  metadata.gz: 5baf06d1f979d9efa535600046b02f384cc53ce3dc794be57e1e799a4cb1a9744b7202725656905940438b0a8081951f5545b9e46f463fa90f0c9ecf870d8a0b
+  data.tar.gz: 585fb0e20ce10d6aec74c764a8b43716dabed99e6c32605f8789837840e3ba80a0ae828dd5ed104fb604f2314e1c405242389bfcffe83b1467cba761b15256c3

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.6

data/Gemfile

@@ -1,13 +1,16 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
 
-gem 'vertebrae', '> 0.5.1'
+source 'http://rubygems.org'
+
+gem 'vertebrae', '>= 0.6.0'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec"
-  gem 'webmock'
+  gem 'bundler'
   gem 'byebug'
-  gem "bundler"
-  gem "juwelier"
+  gem 'juwelier', git: 'https://github.com/flajann2/juwelier.git'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'webmock'
 end

data/Rakefile

@@ -1,12 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -14,13 +14,13 @@ require 'rake'
 require 'juwelier'
 Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "tokyo_api"
-  gem.homepage = "http://github.com/controlshift/tokyo_api"
-  gem.license = "MIT"
-  gem.summary = "Ruby API Wrapper for Tokyo CRM service"
-  gem.description = "Tokyo is a CRM middleware, this gem helps apps talk to it."
-  gem.email = "nathan@controlshiftlabs.com"
-  gem.authors = ["Nathan Woodhull"]
+  gem.name = 'tokyo_api'
+  gem.homepage = 'http://github.com/controlshift/tokyo_api'
+  gem.license = 'MIT'
+  gem.summary = 'Ruby API Wrapper for Tokyo CRM service'
+  gem.description = 'Tokyo is a CRM middleware, this gem helps apps talk to it.'
+  gem.email = 'nathan@controlshiftlabs.com'
+  gem.authors = ['Nathan Woodhull']
   # dependencies defined in Gemfile
 end
 Juwelier::RubygemsDotOrgTasks.new
@@ -36,11 +36,11 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :default => :spec
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "tokyo_api #{version}"

data/VERSION

@@ -1 +1 @@
-1.5.1
+1.6.0

data/example.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 
 require 'tokyo_api'
 
 ta = TokyoApi.new(host: 'localhost:9000', username: 'tokyo', password: 'Passw0rd!', scheme: 'http')
 
-
 require 'pry-debugger'
-binding.pry
+binding.pry

data/lib/tokyo_api.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'vertebrae'
 require 'tokyo_api/base'
 require 'tokyo_api/actionkit'
-require 'tokyo_api/bluestatedigital'
 require 'tokyo_api/campact'
 require 'tokyo_api/client'
 require 'tokyo_api/expire'

data/lib/tokyo_api/actionkit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Actionkit < Base
     def base_path
@@ -9,10 +11,8 @@ module TokyoApi
     end
 
     def user_path(id, required_fields: nil)
-      path = "/#{normalized_base_path}user/#{url_escape(id)}"
-      unless required_fields.nil?
-        path << "?#{required_fields_param(required_fields)}"
-      end
+      path = String.new("/#{normalized_base_path}user/#{url_escape(id)}")
+      path << "?#{required_fields_param(required_fields)}" unless required_fields.nil?
       path
     end
   end

data/lib/tokyo_api/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Base < Vertebrae::Model
     def normalized_base_path
@@ -10,10 +12,10 @@ module TokyoApi
 
     def required_fields_param(required_fields)
       if required_fields.present?
-        "required_fields=#{required_fields.collect{|v| url_escape(v.to_s)}.join(',')}"
+        "required_fields=#{required_fields.collect { |v| url_escape(v.to_s) }.join(',')}"
       else
         ''
       end
     end
   end
-end
+end

data/lib/tokyo_api/campact.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Campact < Base
     def base_path
@@ -17,26 +19,18 @@ module TokyoApi
     end
 
     def subscription_status(token)
-      begin
-        client.get_request(subscription_status_path(token)).body
-      rescue Vertebrae::ResponseError => e
-        # Status 404 is expected in these calls
-        if e.status_code == 404
-          return nil
-        end
-
-        raise
-      end
+      client.get_request(subscription_status_path(token)).body
+    rescue Vertebrae::ResponseError => e
+      # Status 404 is expected in these calls
+      return nil if e.status_code == 404
+
+      raise
     end
 
     def user_path(session_id, petition_id:, with_subscription_status: false, required_fields: nil)
-      path = "/#{normalized_base_path}user/#{url_escape(session_id)}?petition_id=#{url_escape(petition_id)}"
-      if with_subscription_status
-        path << '&with_subscription_status=true'
-      end
-      unless required_fields.nil?
-        path << "&#{required_fields_param(required_fields)}"
-      end
+      path = String.new("/#{normalized_base_path}user/#{url_escape(session_id)}?petition_id=#{url_escape(petition_id)}")
+      path << '&with_subscription_status=true' if with_subscription_status
+      path << "&#{required_fields_param(required_fields)}" unless required_fields.nil?
       path
     end
 

data/lib/tokyo_api/client.rb

@@ -1,16 +1,12 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Client < Vertebrae::API
     def actionkit
       @actionkit ||= TokyoApi::Actionkit.new(client: self)
     end
 
-    alias_method :action_kit, :actionkit
-
-    def bluestatedigital
-      @bluestatedigital ||= TokyoApi::Bluestatedigital.new(client: self)
-    end
-
-    alias_method :blue_state_digital, :bluestatedigital
+    alias action_kit actionkit
 
     def campact
       @campact ||= TokyoApi::Campact.new(client: self)
@@ -24,7 +20,6 @@ module TokyoApi
       @expire ||= TokyoApi::Expire.new(client: self)
     end
 
-
     def default_options
       opts = {
         user_agent: 'TokyoApi Gem',
@@ -32,32 +27,27 @@ module TokyoApi
         content_type: 'application/json'
       }
 
-      if initialisation_options.has_key?(:timeout)
-        opts[:connection_options] = {request: {timeout: initialisation_options[:timeout]}}
+      if initialisation_options.key?(:timeout)
+        opts[:connection_options] = { request: { timeout: initialisation_options[:timeout] } }
       end
 
       opts
     end
 
     def request(method, path, params, options) # :nodoc:
-      if !::Vertebrae::Request::METHODS.include?(method)
-        raise ArgumentError, "unknown http method: #{method}"
-      end
+      raise ArgumentError, "unknown http method: #{method}" unless ::Vertebrae::Request::METHODS.include?(method)
 
-      unless connection.configuration.prefix.blank?
-        path =  connection.configuration.prefix + '/' + path
-      end
+      path = "#{connection.configuration.prefix}/#{path}" unless connection.configuration.prefix.blank?
 
       ::Vertebrae::Base.logger.debug "EXECUTED: #{method} - #{path} with #{params} and #{options}"
 
       connection.connection.send(method) do |request|
-
         case method.to_sym
-          when *(::Vertebrae::Request::METHODS - ::Vertebrae::Request::METHODS_WITH_BODIES)
-            request.url(path, params)
-          when *::Vertebrae::Request::METHODS_WITH_BODIES
-            request.path = path
-            request.body = extract_data_from_params(params) unless params.empty?
+        when *(::Vertebrae::Request::METHODS - ::Vertebrae::Request::METHODS_WITH_BODIES)
+          request.url(path, params)
+        when *::Vertebrae::Request::METHODS_WITH_BODIES
+          request.path = path
+          request.body = extract_data_from_params(params) unless params.empty?
         end
       end
     end
@@ -67,7 +57,8 @@ module TokyoApi
         builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
         if connection.configuration.authenticated?
-          builder.use Faraday::Request::BasicAuthentication, connection.configuration.username, connection.configuration.password
+          builder.use Faraday::Request::BasicAuthentication, connection.configuration.username,
+                      connection.configuration.password
         end
 
         builder.use Faraday::Response::Logger if ENV['DEBUG']

data/lib/tokyo_api/expire.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Expire < Base
     def base_path
@@ -8,4 +10,4 @@ module TokyoApi
       client.get_request("#{normalized_base_path}organisation/#{url_escape(host)}").body
     end
   end
-end
+end

data/lib/tokyo_api/identity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TokyoApi
   class Identity < Base
     def base_path
@@ -9,24 +11,19 @@ module TokyoApi
     end
 
     def tokyo_identity_user_path(id, with_subscription_status: false, required_fields: nil, opt_in_public_ids: nil, minimum_consent_level: nil, encrypted: nil)
-      path = "/#{normalized_base_path}user/#{url_escape(id)}"
+      path = String.new("/#{normalized_base_path}user/#{url_escape(id)}")
 
       params = []
-      unless required_fields.nil?
-        params << required_fields_param(required_fields)
-      end
+      params << required_fields_param(required_fields) unless required_fields.nil?
 
       if with_subscription_status
         params << 'with_subscription_status=true'
-        additional_subscription_parameters = path_for_subscription_status_params(opt_in_public_ids, minimum_consent_level, encrypted)
-        unless additional_subscription_parameters.blank?
-          params << additional_subscription_parameters
-        end
+        additional_subscription_parameters = path_for_subscription_status_params(opt_in_public_ids,
+                                                                                 minimum_consent_level, encrypted)
+        params << additional_subscription_parameters if additional_subscription_parameters.present?
       end
 
-      if params.any?
-        path << "?#{params.join('&')}"
-      end
+      path << "?#{params.join('&')}" if params.any?
 
       path
     end
@@ -34,25 +31,23 @@ module TokyoApi
     def subscription_status_path(id, opt_in_public_ids: nil, minimum_consent_level: nil, encrypted: nil)
       raise 'must provide opt_in_public_ids' if opt_in_public_ids.nil?
 
-      "/#{normalized_base_path}subscription_status/#{url_escape(id)}?#{path_for_subscription_status_params(opt_in_public_ids, minimum_consent_level, encrypted)}"
+      "/#{normalized_base_path}subscription_status/#{url_escape(id)}?#{path_for_subscription_status_params(
+        opt_in_public_ids, minimum_consent_level, encrypted
+      )}"
     end
 
     private
 
     def path_for_subscription_status_params(opt_in_public_ids, minimum_consent_level, encrypted = nil)
-      path = ''
+      path = if opt_in_public_ids.present?
+               String.new("opt_in_public_ids=#{url_escape(opt_in_public_ids.join(','))}")
+             else
+               String.new('')
+             end
 
-      if opt_in_public_ids.present?
-        path = "opt_in_public_ids=#{url_escape(opt_in_public_ids.join(','))}"
-      end
+      path << "&minimum_consent_level=#{url_escape(minimum_consent_level)}" if minimum_consent_level
 
-      if minimum_consent_level
-        path << "&minimum_consent_level=#{url_escape(minimum_consent_level)}"
-      end
-
-      if encrypted
-        path << "&encrypted=1"
-      end
+      path << '&encrypted=1' if encrypted
 
       path
     end

data/spec/actionkit_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::Actionkit do
   subject { TokyoApi.new(host: 'test.com') }
@@ -15,15 +17,15 @@ describe TokyoApi::Actionkit 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.actionkit.full_user('1')).to eq({'error' => 'Connection refused'})
+        expect(subject.actionkit.full_user('1')).to eq({ 'error' => 'Connection refused' })
       end
     end
 
@@ -39,18 +41,22 @@ describe TokyoApi::Actionkit do
 
     describe 'user_path' do
       context 'without required_fields' do
-        it "should return relative path to user API endpoint" do
+        it 'should return relative path to user API endpoint' do
           expect(subject.actionkit.user_path('abc.123.xyz')).to eq('/actionkit/user/abc.123.xyz')
         end
       end
 
       context 'with required_fields' do
-        it "should return relative path to user API endpoint" do
-          expect(subject.actionkit.user_path('abc.123.xyz', required_fields: [:first_name, :last_name, :email, :postal, :phone])).to eq('/actionkit/user/abc.123.xyz?required_fields=first_name,last_name,email,postal,phone')
+        it 'should return relative path to user API endpoint' do
+          expect(subject.actionkit.user_path('abc.123.xyz',
+                                             required_fields: %i[first_name last_name email postal
+                                                                 phone])).to eq('/actionkit/user/abc.123.xyz?required_fields=first_name,last_name,email,postal,phone')
         end
 
         it 'should url-escape field names with weird characters' do
-          expect(subject.actionkit.user_path('abc.123.xyz', required_fields: ['email', 'fish & chips'])).to eq('/actionkit/user/abc.123.xyz?required_fields=email,fish+%26+chips')
+          expect(subject.actionkit.user_path('abc.123.xyz',
+                                             required_fields: ['email',
+                                                               'fish & chips'])).to eq('/actionkit/user/abc.123.xyz?required_fields=email,fish+%26+chips')
         end
       end
     end

data/spec/campact_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::Campact do
   subject { TokyoApi.new(host: 'test.com') }
@@ -15,15 +17,15 @@ describe TokyoApi::Campact 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 message' do
-        expect(subject.campact.full_user('123abc456')).to eq({'error' => 'Connection refused'})
+        expect(subject.campact.full_user('123abc456')).to eq({ 'error' => 'Connection refused' })
       end
     end
 
@@ -31,8 +33,8 @@ describe TokyoApi::Campact do
       let(:body) { fixture('responses/campact/full_user_success') }
 
       it 'should find an organisation' do
-        expect(subject.campact.full_user('123abc456')).to eq({'first_name' => 'Homer', 'last_name' => 'Simpson',
-                                                                  'country' => 'DE', 'postal' => '12345', 'email' => 'foo@bar.com' })
+        expect(subject.campact.full_user('123abc456')).to eq({ 'first_name' => 'Homer', 'last_name' => 'Simpson',
+                                                               'country' => 'DE', 'postal' => '12345', 'email' => 'foo@bar.com' })
       end
     end
   end
@@ -48,15 +50,19 @@ describe TokyoApi::Campact do
     end
 
     it 'should perform request on subscription_status_path' do
-      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_return(double(body: {subscribed: true}))
+      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_return(double(body: { subscribed: true }))
 
       subs_status = subject.subscription_status(token)
 
-      expect(subs_status).to eq({subscribed: true})
+      expect(subs_status).to eq({ subscribed: true })
     end
 
     it 'should return nil if tokyo responds with 404' do
-      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_raise(Vertebrae::ResponseError.new(404, {method: 'get', url: "/campact/subscription_status?token=#{token}", status: '404', body: 'Not Found'}))
+      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_raise(Vertebrae::ResponseError.new(
+                                                                                                              404, {
+                                                                                                                method: 'get', url: "/campact/subscription_status?token=#{token}", status: '404', body: 'Not Found'
+                                                                                                              }
+                                                                                                            ))
 
       subs_status = subject.subscription_status(token)
 
@@ -64,7 +70,10 @@ describe TokyoApi::Campact do
     end
 
     it 'should raise if tokyo responds with other error code' do
-      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_raise(Vertebrae::ResponseError.new(500, {method: 'get', url: "/campact/subscription_status?token=#{token}", status: '500', body: 'Something bad happened'}))
+      expect(client).to receive(:get_request).with("/campact/subscription_status?token=#{token}").and_raise(Vertebrae::ResponseError.new(
+                                                                                                              500, { method: 'get', url: "/campact/subscription_status?token=#{token}", status: '500',
+                                                                                                                     body: 'Something bad happened' }
+                                                                                                            ))
 
       expect { subject.subscription_status(token) }.to raise_error Vertebrae::ResponseError
     end
@@ -72,32 +81,38 @@ describe TokyoApi::Campact do
 
   describe '#user_path' do
     context 'without required_fields' do
-      it "should return relative path to user API endpoint" do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees')).to eq '/campact/user/123abc456?petition_id=save-the-trees'
+      it 'should return relative path to user API endpoint' do
+        expect(subject.campact.user_path('123abc456',
+                                         petition_id: 'save-the-trees')).to eq '/campact/user/123abc456?petition_id=save-the-trees'
       end
     end
 
     context 'with required_fields' do
-      it "should return relative path to user API endpoint" do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees', required_fields: [:first_name, :last_name, :email])).to eq '/campact/user/123abc456?petition_id=save-the-trees&required_fields=first_name,last_name,email'
+      it 'should return relative path to user API endpoint' do
+        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees',
+                                                      required_fields: %i[first_name last_name email])).to eq '/campact/user/123abc456?petition_id=save-the-trees&required_fields=first_name,last_name,email'
       end
 
       it 'should url-escape field names with weird characters' do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees', required_fields: ['email', 'fish & chips'])).to eq '/campact/user/123abc456?petition_id=save-the-trees&required_fields=email,fish+%26+chips'
+        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees',
+                                                      required_fields: ['email', 'fish & chips'])).to eq '/campact/user/123abc456?petition_id=save-the-trees&required_fields=email,fish+%26+chips'
       end
     end
 
     context 'with_subscription_status argument' do
       it 'should not include query string parameter if argument is missing' do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees')).not_to match /.+with_subscription_status=.+/
+        expect(subject.campact.user_path('123abc456',
+                                         petition_id: 'save-the-trees')).not_to match(/.+with_subscription_status=.+/)
       end
 
       it 'should not include query string parameter if argument is false' do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees', with_subscription_status: false)).not_to match /.+with_subscription_status=.+/
+        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees',
+                                                      with_subscription_status: false)).not_to match(/.+with_subscription_status=.+/)
       end
 
       it 'should include query string parameter if argument is true' do
-        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees', with_subscription_status: true)).to match /.+with_subscription_status=true.*/
+        expect(subject.campact.user_path('123abc456', petition_id: 'save-the-trees',
+                                                      with_subscription_status: true)).to match(/.+with_subscription_status=true.*/)
       end
     end
   end
@@ -117,7 +132,9 @@ describe TokyoApi::Campact do
     subject { TokyoApi::Campact.new(client: client) }
 
     it 'should perform request on session status path' do
-      expect(client).to receive(:get_request).with("/campact/session/#{session_id}/status").and_return(double(body: { hard_login: false, soft_login: true }))
+      expect(client).to receive(:get_request).with("/campact/session/#{session_id}/status").and_return(double(body: {
+                                                                                                                hard_login: false, soft_login: true
+                                                                                                              }))
 
       session_status = subject.session_status(session_id)
 

data/spec/client_spec.rb

@@ -1,11 +1,13 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
 
 describe TokyoApi::Client do
   describe 'initialisation' do
     subject { described_class.new(options) }
 
     context 'with a basic_auth string parameter' do
-      let(:options) { {basic_auth: 'login:password'} }
+      let(:options) { { basic_auth: 'login:password' } }
 
       it 'should set username/password on the configuration' do
         config = subject.connection.configuration
@@ -15,7 +17,7 @@ describe TokyoApi::Client do
     end
 
     context 'with a timeout' do
-      let(:options) { {timeout: 5} }
+      let(:options) { { timeout: 5 } }
 
       it 'should set the timeout on the faraday options' do
         config = subject.connection.configuration

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.5.1 ruby lib
+# stub: tokyo_api 1.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tokyo_api".freeze
-  s.version = "1.5.1"
+  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 = "2020-04-29"
+  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 = [
@@ -33,19 +33,16 @@ 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",
     "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",
@@ -58,34 +55,37 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/tokyo_api".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.4".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.5.1"])
-      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.5.1"])
-      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.5.1"])
-    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,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: tokyo_api
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Nathan Woodhull
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: juwelier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: rubocop
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,19 +130,16 @@ 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
 - 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
@@ -142,7 +153,7 @@ homepage: http://github.com/controlshift/tokyo_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby API Wrapper for Tokyo CRM service
 test_files: []

data/lib/tokyo_api/bluestatedigital.rb

@@ -1,19 +0,0 @@
-module TokyoApi
-  class Bluestatedigital < Base
-    def base_path
-      'bluestatedigital'
-    end
-
-    def full_user(id)
-      client.get_request("#{normalized_base_path}full_user/#{url_escape(id)}").body
-    end
-
-    def tokyo_blue_state_digital_user_path(id, required_fields: nil)
-      path = "/#{normalized_base_path}constituent/#{url_escape(id)}"
-      unless required_fields.nil?
-        path << "?#{required_fields_param(required_fields)}"
-      end
-      path
-    end
-  end
-end

data/spec/bluestatedigital_spec.rb

@@ -1,58 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe TokyoApi::Bluestatedigital do
-  subject { TokyoApi.new(host: 'test.com') }
-
-  describe 'configuration' do
-    it 'should propagate the host' do
-      expect(subject.bluestatedigital.client.connection.configuration.host).to eq('test.com')
-    end
-  end
-
-  describe 'full_user' do
-    let(:body) { fixture('responses/full_user_success') }
-    let(:request_path) { '/bluestatedigital/full_user/1' }
-    let(:status) { 200 }
-
-    before(:each) do
-      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 message' do
-        expect(subject.bluestatedigital.full_user('1')).to eq({'error' => 'Connection refused'})
-      end
-    end
-
-    describe 'success' do
-      let(:body) { fixture('responses/bluestatedigital/full_user_success') }
-
-      it 'should return a success hash' do
-        expect(subject.bluestatedigital.full_user('1')).to eq({ 'first_name' => 'Homer', 'last_name' => 'Simpson',
-                                                                'city' => 'Springfield', 'state' => 'YZ', 'country' => 'US',
-                                                                'postal' => '12345', 'email' => 'foo@bar.com' })
-      end
-    end
-  end
-
-  describe 'tokyo_blue_state_digital_user_path' do
-    context 'without required_fields' do
-      it "should return rooted relative path to tokyo user API endpoint" do
-        expect(subject.bluestatedigital.tokyo_blue_state_digital_user_path('-123456')).to eq('/bluestatedigital/constituent/-123456')
-      end
-    end
-
-    context 'with required_fields' do
-      it "should return rooted relative path to tokyo user API endpoint" do
-        expect(subject.bluestatedigital.tokyo_blue_state_digital_user_path('-123456', required_fields: [:first_name, :last_name, :email, :postal, :phone])).to eq('/bluestatedigital/constituent/-123456?required_fields=first_name,last_name,email,postal,phone')
-      end
-
-      it 'should url-escape field names with weird characters' do
-        expect(subject.bluestatedigital.tokyo_blue_state_digital_user_path('-123456', required_fields: ['email', 'fish & chips'])).to eq('/bluestatedigital/constituent/-123456?required_fields=email,fish+%26+chips')
-      end
-    end
-  end
-end

data/spec/fixtures/responses/bluestatedigital/full_user_success

@@ -1 +0,0 @@
-{"first_name":"Homer","last_name":"Simpson","city":"Springfield","state":"YZ","country":"US","postal":"12345","email":"foo@bar.com"}