tokyo_api 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 608376ec5c22df615936ab9c5603877f983e3f1c36c93071f3e4e4195bc6012e
-  data.tar.gz: 48218037c0aa31d24ca5f708311677387172422adc63a1ee5a0f190b3f92bfd2
+  metadata.gz: da756851722d19fe2817efef68b7800fc078f3a56e6494fbd83e1728576dcb92
+  data.tar.gz: ea742d2a8fb9a47eb773b60c0b7d364b9e4057d9679c4f4da9fc8a6cdf7097ca
 SHA512:
-  metadata.gz: 5baf06d1f979d9efa535600046b02f384cc53ce3dc794be57e1e799a4cb1a9744b7202725656905940438b0a8081951f5545b9e46f463fa90f0c9ecf870d8a0b
-  data.tar.gz: 585fb0e20ce10d6aec74c764a8b43716dabed99e6c32605f8789837840e3ba80a0ae828dd5ed104fb604f2314e1c405242389bfcffe83b1467cba761b15256c3
+  metadata.gz: 918a3f26f02b51ba6893f218b3dab6f34e9089d163715b10947aabff02ba1f8bf0890cfd637070944865c8cf0f1da1f0045241f28aad4a2e60f1e62e055edbcd
+  data.tar.gz: 7633e4061040949bf31d27352f7e6a4e1119c96e8b6959588e1b350b1721bad1c05745a3da5d8daba63d527ae96be976454538f1335b61d58d59aaee14296820

data/.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: CI
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.2

data/README.md

@@ -1,8 +1,8 @@
-# tokyo_api
+# tokyo\_api
 
 A ruby gem for communicating with ControlShift's Tokyo API.
 
-[![Build Status](https://travis-ci.org/controlshift/tokyo_api.svg)](https://travis-ci.org/controlshift/tokyo_api)
+[![CI Status](https://github.com/controlshift/tokyo_api/actions/workflows/ci.yml/badge.svg)](https://github.com/controlshift/tokyo_api/actions/workflows/ci.yml)
 
 ## Usage
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.8.0

data/lib/tokyo_api/client.rb

@@ -16,6 +16,10 @@ module TokyoApi
       @identity ||= TokyoApi::Identity.new(client: self)
     end
 
+    def external_image
+      @external_image ||= TokyoApi::ExternalImage.new(client: self)
+    end
+
     def expire
       @expire ||= TokyoApi::Expire.new(client: self)
     end

data/lib/tokyo_api/external_image.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TokyoApi
+  class ExternalImage < Base
+    def base_path
+      'external_image'
+    end
+
+    def track_download(photo_id)
+      client.post_request("#{normalized_base_path}#{url_escape(photo_id)}/download").status == 204
+    end
+  end
+end

data/lib/tokyo_api/identity.rb

@@ -10,18 +10,15 @@ module TokyoApi
       client.get_request("#{normalized_base_path}full_user/#{url_escape(id)}").body
     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)
+    def tokyo_identity_user_path(id, required_fields: nil, opt_in_public_ids: nil, minimum_consent_level: nil, encrypted: nil)
       path = String.new("/#{normalized_base_path}user/#{url_escape(id)}")
 
       params = []
       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)
-        params << additional_subscription_parameters if additional_subscription_parameters.present?
-      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?
 
       path << "?#{params.join('&')}" if params.any?
 

data/lib/tokyo_api.rb

@@ -5,6 +5,7 @@ require 'tokyo_api/base'
 require 'tokyo_api/actionkit'
 require 'tokyo_api/campact'
 require 'tokyo_api/client'
+require 'tokyo_api/external_image'
 require 'tokyo_api/expire'
 require 'tokyo_api/identity'
 

data/spec/external_image_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
+
+describe TokyoApi::ExternalImage do
+  subject { TokyoApi.new(host: 'test.com') }
+
+  describe '#track_download' do
+    let(:photo_id) { 'abcde-123456' }
+    let(:request_path) { "/external_image/#{photo_id}/download" }
+
+    before(:each) do
+      stub_post(request_path).to_return(body: body, status: status,
+                                       headers: { content_type: 'application/json; charset=utf-8' })
+    end
+
+    context 'error on tokyo' do
+      let(:status) { 500 }
+      let(:body) { {status: :error}.to_json }
+
+      it 'should raise error' do
+        expect { subject.external_image.track_download(photo_id) }.to raise_error(Vertebrae::ResponseError)
+      end
+    end
+
+    context 'successful call to tokyo' do
+      let(:status) { 204 }
+      let(:body) { nil }
+
+      it 'should return true' do
+        result = subject.external_image.track_download(photo_id)
+
+        expect(result).to be_truthy
+      end
+    end
+  end
+end

data/spec/identity_spec.rb

@@ -60,49 +60,20 @@ describe TokyoApi::Identity do
       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=.+/)
-      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=.+/)
-      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')
-
-        expect(tokyo_path).not_to match(/.+opt_in_public_ids=.+/)
-        expect(tokyo_path).not_to match(/.+minimum_consent_level=.+/)
-      end
+    it 'should include encrypted parameter if argument is true' do
+      expect(subject.identity.tokyo_identity_user_path('123abc456', encrypted: true)).to match(/.+encrypted=.+/)
+    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=.+/)
-      end
+    it 'should include opt_in_public_ids and minimum_consent_level' do
+      tokyo_path = subject.identity.tokyo_identity_user_path('123abc456',
+                                                             required_fields: %i[first_name last_name email
+                                                                                 postal phone],
+                                                             opt_in_public_ids: ['policy-1.5'],
+                                                             minimum_consent_level: 'explicit')
 
-      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=.+/)
-      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: %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
+      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
 

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.6.0 ruby lib
+# stub: tokyo_api 1.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tokyo_api".freeze
-  s.version = "1.6.0"
+  s.version = "1.8.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 = "2021-03-24"
+  s.date = "2022-11-25"
   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 = [
@@ -20,10 +20,10 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".github/workflows/ci.yml",
     ".rspec",
     ".ruby-gemset",
     ".ruby-version",
-    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
@@ -36,11 +36,13 @@ Gem::Specification.new do |s|
     "lib/tokyo_api/campact.rb",
     "lib/tokyo_api/client.rb",
     "lib/tokyo_api/expire.rb",
+    "lib/tokyo_api/external_image.rb",
     "lib/tokyo_api/identity.rb",
     "spec/actionkit_spec.rb",
     "spec/campact_spec.rb",
     "spec/client_spec.rb",
     "spec/expire_spec.rb",
+    "spec/external_image_spec.rb",
     "spec/fixtures/expire/success",
     "spec/fixtures/responses/actionkit/full_user_success",
     "spec/fixtures/responses/campact/full_user_success",
@@ -55,29 +57,21 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/controlshift/tokyo_api".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.8".freeze
+  s.rubygems_version = "3.3.19".freeze
   s.summary = "Ruby API Wrapper for Tokyo CRM service".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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.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
+  if s.respond_to? :add_runtime_dependency then
+    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.6.0"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokyo_api
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Nathan Woodhull
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -117,10 +117,10 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".github/workflows/ci.yml"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,11 +133,13 @@ files:
 - lib/tokyo_api/campact.rb
 - lib/tokyo_api/client.rb
 - lib/tokyo_api/expire.rb
+- lib/tokyo_api/external_image.rb
 - lib/tokyo_api/identity.rb
 - spec/actionkit_spec.rb
 - spec/campact_spec.rb
 - spec/client_spec.rb
 - spec/expire_spec.rb
+- spec/external_image_spec.rb
 - spec/fixtures/expire/success
 - spec/fixtures/responses/actionkit/full_user_success
 - spec/fixtures/responses/campact/full_user_success
@@ -153,7 +155,7 @@ homepage: http://github.com/controlshift/tokyo_api
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.3.19
+signing_key: 
 specification_version: 4
 summary: Ruby API Wrapper for Tokyo CRM service
 test_files: []

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - "2.3.3"