tokyo_api 0.6.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12d2d3a99c115528e680c6cad6fac2c2dd016ddf
-  data.tar.gz: be23032d01f274d9639af99f419ed35b04e9a74f
+  metadata.gz: 79401acf7c96745e5ace0e9aee6cde215ab3872a
+  data.tar.gz: c785ce0ee3fe07bdb3797e89c66a858fa9ba88cf
 SHA512:
-  metadata.gz: 639b6d88d3e5fc1db184da6cd35c1095c48626e207b1f769ce01a8ae44cf54e3cbb245db747b1b5833119a8b427ef96b05769e686bd1bb5d33852990f6e46809
-  data.tar.gz: 60bb05952d75302a17e54293e603e316d121d40b8ad124d55254bda7ba75327a0a7c5f8fb5f3ea0d7da4cce76f17177f258d79084bae3424627b8d8fc8499d74
+  metadata.gz: 0dfb6516012f4917d445f6834741b1a404c5f1a594cfe753dd92d0d688c7372a8b444e4a46673e6b70572e5a1f5b8adcd3bf0e3348784e4946968b69d4a7c9ea
+  data.tar.gz: 990d1937b86831cb4b6e78a7cfd6a53ca65e215886ac20fb4d54a989e76c6fa038bc318f84e7cafc521f137bfafb31a5e811b5aaf767711b39ea9ae2f297d02b

data/VERSION

@@ -1 +1 @@
-0.6.1
+1.0.1

data/lib/tokyo_api/actionkit.rb

@@ -5,11 +5,15 @@ module TokyoApi
     end
 
     def full_user(id)
-      client.get_request("#{normalized_base_path}full_user/#{id}").body
+      client.get_request("#{normalized_base_path}full_user/#{url_escape(id)}").body
     end
 
-    def user_path(id, phone_required)
-      "/#{normalized_base_path}user/#{id}?phone_required=#{phone_required}"
+    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
     end
   end
-end
+end

data/lib/tokyo_api/base.rb

@@ -3,5 +3,17 @@ module TokyoApi
     def normalized_base_path
       "#{base_path}/"
     end
+
+    def url_escape(string)
+      CGI.escape(string)
+    end
+
+    def required_fields_param(required_fields)
+      if required_fields.present?
+        "required_fields=#{required_fields.collect{|v| url_escape(v.to_s)}.join(',')}"
+      else
+        ''
+      end
+    end
   end
 end

data/lib/tokyo_api/bluestatedigital.rb

@@ -5,11 +5,15 @@ module TokyoApi
     end
 
     def full_user(id)
-      client.get_request("#{normalized_base_path}full_user/#{id}").body
+      client.get_request("#{normalized_base_path}full_user/#{url_escape(id)}").body
     end
 
-    def tokyo_blue_state_digital_user_path(id, phone_required)
-      "/#{normalized_base_path}constituent/#{id}?phone_required=#{phone_required}"
+    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
+end

data/lib/tokyo_api/expire.rb

@@ -5,7 +5,7 @@ module TokyoApi
     end
 
     def organisation(host)
-      client.get_request("#{normalized_base_path}organisation/#{host}").body
+      client.get_request("#{normalized_base_path}organisation/#{url_escape(host)}").body
     end
   end
 end

data/lib/tokyo_api/identity.rb

@@ -5,11 +5,16 @@ module TokyoApi
     end
 
     def full_user(id)
-      client.get_request("#{normalized_base_path}full_user/#{id}").body
+      client.get_request("#{normalized_base_path}full_user/#{url_escape(id)}").body
     end
 
-    def tokyo_identity_user_path(id, phone_required)
-      "/#{normalized_base_path}user/#{id}?phone_required=#{phone_required}"
+    def tokyo_identity_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
     end
   end
 end

data/lib/tokyo_api/krautbuster.rb

@@ -5,11 +5,11 @@ module TokyoApi
     end
 
     def full_user(session_id)
-      client.get_request("#{normalized_base_path}full_user/#{session_id}").body
+      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/#{session_id}").body
+      client.get_request("#{normalized_base_path}session_status/#{url_escape(session_id)}").body
     end
 
     def subscription_status(token)
@@ -25,12 +25,16 @@ module TokyoApi
       end
     end
 
-    def user_path(session_id, petition_id)
-      "/#{normalized_base_path}user/#{session_id}?petition_id=#{petition_id}"
+    def user_path(session_id, petition_id:, required_fields: nil)
+      path = "/#{normalized_base_path}user/#{url_escape(session_id)}?petition_id=#{url_escape(petition_id)}"
+      unless required_fields.nil?
+        path << "&#{required_fields_param(required_fields)}"
+      end
+      path
     end
 
     def subscription_status_path(token)
-      "/#{normalized_base_path}subscription_status/#{token}"
+      "/#{normalized_base_path}subscription_status/#{url_escape(token)}"
     end
   end
-end
+end

data/spec/actionkit_spec.rb

@@ -38,15 +38,19 @@ describe TokyoApi::Actionkit do
     end
 
     describe 'user_path' do
-      context 'phone not required' do
+      context 'without required_fields' do
         it "should return relative path to user API endpoint" do
-          expect(subject.actionkit.user_path('abc.123.xyz', false)).to eq('/actionkit/user/abc.123.xyz?phone_required=false')
+          expect(subject.actionkit.user_path('abc.123.xyz')).to eq('/actionkit/user/abc.123.xyz')
         end
       end
 
-      context 'phone required' do
+      context 'with required_fields' do
         it "should return relative path to user API endpoint" do
-          expect(subject.actionkit.user_path('abc.123.xyz', true)).to eq('/actionkit/user/abc.123.xyz?phone_required=true')
+          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')
+        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')
         end
       end
     end

data/spec/bluestatedigital_spec.rb

@@ -39,15 +39,19 @@ describe TokyoApi::Bluestatedigital do
   end
 
   describe 'tokyo_blue_state_digital_user_path' do
-    context 'phone not required' 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', false)).to eq('/bluestatedigital/constituent/-123456?phone_required=false')
+        expect(subject.bluestatedigital.tokyo_blue_state_digital_user_path('-123456')).to eq('/bluestatedigital/constituent/-123456')
       end
     end
 
-    context 'phone required' do
+    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', true)).to eq('/bluestatedigital/constituent/-123456?phone_required=true')
+        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

data/spec/identity_spec.rb

@@ -38,15 +38,19 @@ describe TokyoApi::Identity do
   end
 
   describe 'tokyo_identity_user_path' do
-    context 'phone not required' do
+    context 'without required_fields' do
       it 'should return rooted relative path to tokyo user API endpoint' do
-        expect(subject.identity.tokyo_identity_user_path('-123456', false)).to eq('/identity/user/-123456?phone_required=false')
+        expect(subject.identity.tokyo_identity_user_path('-123456')).to eq('/identity/user/-123456')
       end
     end
 
-    context 'phone required' 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', true)).to eq('/identity/user/-123456?phone_required=true')
+        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')
+      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')
       end
     end
   end

data/spec/krautbuster_spec.rb

@@ -71,8 +71,20 @@ describe TokyoApi::Krautbuster do
   end
 
   describe '#user_path' do
-    it "should return relative path to user API endpoint" do
-      expect(subject.krautbuster.user_path('123abc456', 'save-the-trees')).to eq '/krautbuster/user/123abc456?petition_id=save-the-trees'
+    context 'without required_fields' do
+      it "should return relative path to user API endpoint" do
+        expect(subject.krautbuster.user_path('123abc456', petition_id: 'save-the-trees')).to eq '/krautbuster/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.krautbuster.user_path('123abc456', petition_id: 'save-the-trees', required_fields: [:first_name, :last_name, :email])).to eq '/krautbuster/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.krautbuster.user_path('123abc456', petition_id: 'save-the-trees', required_fields: ['email', 'fish & chips'])).to eq '/krautbuster/user/123abc456?petition_id=save-the-trees&required_fields=email,fish+%26+chips'
+      end
     end
   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 0.6.1 ruby lib
+# stub: tokyo_api 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tokyo_api".freeze
-  s.version = "0.6.1"
+  s.version = "1.0.1"
 
   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 = "2017-08-21"
+  s.date = "2017-09-07"
   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 = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokyo_api
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Woodhull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae