tokyo_api 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5502304c73c869022683e520632e96fc836a552bfb98b876498476121bfb620e
-  data.tar.gz: 517684ab971c1d9ed655991090a11c87688414cefee2df384b1d4e642dcbc627
+  metadata.gz: 2c13c06a403dbc3eeb297a65c97be04e9c6c4ecdc57faf3319fcaffc13a65752
+  data.tar.gz: b7809a0fbf2cb061a1d187727485dfa4486c8eb82e93f22fb4eca82a3d303fa3
 SHA512:
-  metadata.gz: 0e0b6958e59a6fa7c3ede1d910b3a75fe002bd1741d999b7330bfa79d071590ef12bad60af9769fb9c4af43f3b06e05fbc271dc8996a4ee1bf8b60f713f3f1ce
-  data.tar.gz: d10d735108fefa5a62bde79320e3a4184f62f108e878d813c2e7f0de3631aa0f6f91529298e701aacf0302f20bfe7967498a0dbea06dcc473973c7317897d115
+  metadata.gz: 6ba8f238329548d345363e5b7819172104559e6dda78cf8fd188978562e71e0578362091f57a5129862473e61b41f619bb737694eb61f05cce72aa35156becc7
+  data.tar.gz: a31540d25ae73fd9758d68b8e985a37f94defeacb2e833117927b6c8778d63226fc02c90127c0aed5969e94c85439aa58b400bf859039a427210a06db6208c41

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/lib/tokyo_api/campact.rb

@@ -0,0 +1,43 @@
+module TokyoApi
+  class Campact < Base
+    def base_path
+      'campact'
+    end
+
+    def full_user(session_id)
+      client.get_request("#{normalized_base_path}full_user/#{url_escape(session_id)}").body
+    end
+
+    def session_status(session_id)
+      client.get_request("#{normalized_base_path}session_status/#{url_escape(session_id)}").body
+    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
+    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
+    end
+
+    def subscription_status_path(token)
+      "/#{normalized_base_path}subscription_status/#{url_escape(token)}"
+    end
+  end
+end

data/lib/tokyo_api/client.rb

@@ -12,6 +12,10 @@ module TokyoApi
       @krautbuster ||= TokyoApi::Krautbuster.new(client: self)
     end
 
+    def campact
+      @campact ||= TokyoApi::Campact.new(client: self)
+    end
+
     def identity
       @identity ||= TokyoApi::Identity.new(client: self)
     end

data/lib/tokyo_api.rb

@@ -2,10 +2,11 @@ require 'vertebrae'
 require 'tokyo_api/base'
 require 'tokyo_api/actionkit'
 require 'tokyo_api/bluestatedigital'
-require 'tokyo_api/krautbuster'
-require 'tokyo_api/identity'
-require 'tokyo_api/expire'
+require 'tokyo_api/campact'
 require 'tokyo_api/client'
+require 'tokyo_api/expire'
+require 'tokyo_api/identity'
+require 'tokyo_api/krautbuster'
 
 module TokyoApi
   extend Vertebrae::Base

data/spec/campact_spec.rb

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TokyoApi::Campact do
+  subject { TokyoApi.new(host: 'test.com') }
+
+  describe 'configuration' do
+    it 'should propagate the host' do
+      expect(subject.campact.client.connection.configuration.host).to eq 'test.com'
+    end
+  end
+
+  describe '#full_user' do
+    let(:body) { fixture('responses/full_user_success') }
+    let(:request_path) { '/campact/full_user/123abc456' }
+    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.campact.full_user('123abc456')).to eq({'error' => 'Connection refused'})
+      end
+    end
+
+    describe 'success' 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' })
+      end
+    end
+  end
+
+  describe '#subscription_status' do
+    let(:client) { double }
+    let(:token) { '2134567890abcdef' }
+
+    subject { TokyoApi::Campact.new(client: client) }
+
+    before :each do
+      expect(subject).to receive(:subscription_status_path).with(token).and_return("/campact/subscription_status?token=#{token}")
+    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}))
+
+      subs_status = subject.subscription_status(token)
+
+      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'}))
+
+      subs_status = subject.subscription_status(token)
+
+      expect(subs_status).to be_nil
+    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 { subject.subscription_status(token) }.to raise_error Vertebrae::ResponseError
+    end
+  end
+
+  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'
+      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'
+      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'
+      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=.+/
+      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=.+/
+      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.*/
+      end
+    end
+  end
+
+  describe '#subscription_status_path' do
+    subject { TokyoApi::Campact.new }
+
+    it 'should return correct path' do
+      expect(subject.subscription_status_path('abc123')).to eq '/campact/subscription_status/abc123'
+    end
+  end
+end

data/spec/fixtures/responses/campact/full_user_success

@@ -0,0 +1 @@
+{"first_name":"Homer","last_name":"Simpson","country":"DE","postal":"12345","email":"foo@bar.com"}

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.1.2 ruby lib
+# stub: tokyo_api 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tokyo_api".freeze
-  s.version = "1.1.2"
+  s.version = "1.2.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-05-14"
+  s.date = "2018-08-31"
   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 = [
@@ -35,17 +35,20 @@ Gem::Specification.new do |s|
     "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",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokyo_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Nathan Woodhull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -118,17 +118,20 @@ files:
 - 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