cta_aggregator_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 409f45de3418b9c9b28d8658dba105cc036f1173
+  data.tar.gz: caff1471ad88c925a46d1ab2037613bd1f435eab
+SHA512:
+  metadata.gz: 611d21df72ce9c2c93aedf0aeb9aeb3fb210d7af405882b89c0abc0d69c592eb7a1802b0dc748f8bc768a83476324d48eb25ba4ed9120c37dedc5e5401f8a40f
+  data.tar.gz: eb92d66882035b642d7beba93572aad7607dff1c0175762686a83b4a9b0825c9ee1b8e4f2508dc77562711df19f88291ff751e78df294c23e0aab81d17ee8bc5

data/lib/cta_aggregator_client/advocacy_campaign.rb

@@ -0,0 +1,17 @@
+require 'cta_aggregator_client/cta_resource'
+
+module CTAAggregatorClient
+  module AdvocacyCampaign
+    extend CTAResource
+
+    RESOURCE_NAME = :advocacy_campaign
+
+    class << self
+
+      def resource_name
+        RESOURCE_NAME
+      end
+
+    end
+  end
+end

data/lib/cta_aggregator_client/api/authenticator.rb

@@ -0,0 +1,46 @@
+require 'cta_aggregator_client/api/utilities'
+
+module CTAAggregatorClient
+  module API
+    module Authenticator 
+      extend Utilities
+
+      THREE_HOURS = 10800
+
+      class << self
+
+        def headers_with_authentication 
+          reset_auth unless Time.now < auth.expiration
+          default_headers.merge(authorization: "Bearer: #{auth.token}")
+        end
+
+        def auth
+          @auth ||= generate_auth
+        end
+
+        def generate_auth
+          raw_response = RestClient.post(auth_url, nil, headers_with_auth_creds)
+          token = raw_response.code == 201 ? JSON.parse(raw_response.body)["jwt"] : nil
+
+          Auth.new(
+            token,
+            default_token_expiration
+          )
+        end
+
+        def default_token_expiration
+          # API is more lenient on token expriation (way over 3 hours).
+          # We're keeping low expiration here to avoid dealing with expired tokens.
+          Time.now + THREE_HOURS
+        end
+
+        def reset_auth
+          @auth = nil
+        end
+
+        class Auth < Struct.new(:token, :expiration) ; end
+
+      end
+    end
+  end
+end

data/lib/cta_aggregator_client/api/client.rb

@@ -0,0 +1,93 @@
+require 'rest-client'
+require 'json'
+require 'cta_aggregator_client/response'
+require 'cta_aggregator_client/api/utilities'
+require 'cta_aggregator_client/api/authenticator'
+
+module CTAAggregatorClient
+  module API
+    module Client 
+      extend Utilities
+
+      class << self
+
+        def list(resource_name, filters)
+          url = "#{base_url}/#{api_version}/#{resource_name}s"
+          raw_response = RestClient.get(url, {headers: default_headers, params: {filter:  filters} })
+          translate_response(raw_response)
+        end
+
+        def find(resource_name, uuid)
+          url = "#{base_url}/#{api_version}/#{resource_name}s/#{uuid}"
+          raw_response = RestClient.get(url, default_headers)
+          translate_response(raw_response)
+        end
+
+        def create(resource_name, attributes, relationships = {})
+          url = "#{base_url}/#{api_version}/#{resource_name}s"
+          payload = {
+            'data': {
+              'type': "#{resource_name}s",
+              'attributes': attributes,
+              'relationships': relationship_params(relationships)
+            }.reject{ |k,v| v.empty? }
+          }.to_json
+
+          perform_authenticated_request(:post, url, payload)
+        end
+
+        def relationship_params(relationships)
+          return {} unless relationships
+
+          relationships.each_with_object({}) do |(resource_name, uuid_data), obj|
+            if uuid_data.is_a? Array
+              obj[resource_name.to_sym] = {
+                data: uuid_data.map {  |uuid| { type: resource_name, id: uuid } }
+              }
+            else
+              obj[resource_name.to_sym] = {
+                data: { type: "#{resource_name}s", id: uuid_data }
+              }
+            end
+          end
+        end
+
+        def add_relationship(resource_name, uuid, related_resource_name, related_resource_uuids)
+          url = "#{base_url}/#{api_version}/#{resource_name}s/#{uuid}/relationships/#{related_resource_name}"
+          if related_resource_uuids.is_a? Array
+
+            resource_data = related_resource_uuids.map do |related_resource_uuid|
+              { 'type': "#{related_resource_name}",
+                'id': related_resource_uuid }
+            end
+
+          elsif related_resource_uuids.is_a? String
+            resource_data = { 'type': "#{related_resource_name}",
+                              'id': related_resource_uuids }
+          else
+            raise UnknownInputTypeError
+          end
+
+          payload = { data: resource_data }.to_json
+
+          perform_authenticated_request(:put, url, payload)
+        end
+
+        def perform_authenticated_request(http_method, url, payload)
+          raw_response = RestClient.send(http_method.to_sym, url, payload, headers_with_access_token)
+          translate_response(raw_response)
+        end
+
+        def headers_with_access_token
+          Authenticator.headers_with_authentication
+        end
+
+        def translate_response(response)
+          Response.new(response.code, response.body, response.headers)
+        end
+
+        class UnknownInputTypeError < StandardError ; end
+      end
+    end
+  end
+end

data/lib/cta_aggregator_client/api/utilities.rb

@@ -0,0 +1,36 @@
+module CTAAggregatorClient
+  module API
+    module Utilities
+
+      def default_headers
+        { content_type: 'application/vnd.api+json',
+          accept: 'application/vnd.api+json'}
+      end
+
+      def headers_with_auth_creds
+        default_headers.merge(authorization: "#{api_key}:#{api_secret}")
+      end
+
+      def base_url
+        CTAAggregatorClient.configuration.base_url
+      end
+
+      def api_version
+        CTAAggregatorClient.configuration.api_version
+      end
+
+      def auth_url
+        "#{base_url}/#{api_version}/authorize"
+      end
+
+      def api_key
+        CTAAggregatorClient.configuration.api_key
+      end
+
+      def api_secret
+        CTAAggregatorClient.configuration.api_secret
+      end
+
+    end
+  end
+end

data/lib/cta_aggregator_client/configuration.rb

@@ -0,0 +1,14 @@
+module CTAAggregatorClient
+  class Configuration
+
+    attr_accessor :base_url, :api_version, :api_key, :api_secret
+
+    def initialize
+      @base_url = nil
+      @api_version = nil
+      @api_key = nil
+      @api_secret = nil
+    end
+
+  end
+end

data/lib/cta_aggregator_client/cta_resource.rb

@@ -0,0 +1,23 @@
+require 'cta_aggregator_client/api/client'
+
+module CTAAggregatorClient
+  module CTAResource
+
+    def list(filters = {})
+      API::Client.list(resource_name, filters)
+    end
+
+    def find(uuid)
+      API::Client.find(resource_name, uuid)
+    end
+
+    def create(attributes, relationships = {})
+      API::Client.create(resource_name, attributes, relationships)
+    end
+
+    def resource_name
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/cta_aggregator_client/event.rb

@@ -0,0 +1,17 @@
+require 'cta_aggregator_client/cta_resource'
+
+module CTAAggregatorClient
+  module Event
+    extend CTAResource
+
+    RESOURCE_NAME = :event
+
+    class << self
+
+      def resource_name
+        RESOURCE_NAME
+      end
+
+    end
+  end
+end

data/lib/cta_aggregator_client/location.rb

@@ -0,0 +1,17 @@
+require 'cta_aggregator_client/cta_resource'
+
+module CTAAggregatorClient
+  module Location
+    extend CTAResource
+
+    RESOURCE_NAME = :location
+
+    class << self
+
+      def resource_name
+        RESOURCE_NAME
+      end
+
+    end
+  end
+end

data/lib/cta_aggregator_client/response.rb

@@ -0,0 +1,5 @@
+module CTAAggregatorClient
+  class Response < Struct.new(:code, :body, :headers)
+
+  end
+end

data/lib/cta_aggregator_client/target.rb

@@ -0,0 +1,17 @@
+require 'cta_aggregator_client/cta_resource'
+
+module CTAAggregatorClient
+  module Target 
+    extend CTAResource
+
+    RESOURCE_NAME = :target
+
+    class << self
+
+      def resource_name
+        RESOURCE_NAME
+      end
+
+    end
+  end
+end

data/lib/cta_aggregator_client/version.rb

@@ -0,0 +1,3 @@
+module CTAAggregatorClient
+  VERSION = '0.1.0'
+end

data/lib/cta_aggregator_client.rb

@@ -0,0 +1,22 @@
+require 'cta_aggregator_client/configuration'
+require 'cta_aggregator_client/api/client'
+require 'cta_aggregator_client/advocacy_campaign'
+require 'cta_aggregator_client/target'
+require 'cta_aggregator_client/event'
+require 'cta_aggregator_client/location'
+
+module CTAAggregatorClient
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+end

data/spec/factory.rb

@@ -0,0 +1,32 @@
+require 'rspec'
+
+module Factory
+
+  class << self
+
+    def response(code: 200, body: nil)
+      CTAAggregatorClient::Response.new(
+        code,
+        body,
+        { content_type: 'application/vnd.api+json' }
+      )
+    end
+
+    def auth_response
+      Factory.response(code: 201, body: {jwt: token}.to_json)
+    end
+
+    def bad_token_response
+      Factory.response(code: 401)
+    end
+
+    def bad_auth_response
+      Factory.response(code: 404)
+    end
+
+    def token
+      'as.df.gh'
+    end
+
+  end
+end

data/spec/helpers/test_helpers.rb

@@ -0,0 +1,26 @@
+module TestHelpers
+
+  # Coerces a class name into pluralized resource name 
+  # e.g. "CTAAggregatorClient::CallScript" to "call-scripts" 
+  def formatted_resource_name(klass, hardcoded_klass_name)
+    resource_name = "#{(hardcoded_klass_name || klass.name.split("::")[1].split(/(?=[A-Z])/).map { |class_name_part| class_name_part.downcase }.join('_'))}s"
+  end
+
+  def api_url
+    "#{CTAAggregatorClient::configuration.base_url}/#{CTAAggregatorClient.configuration.api_version}"
+  end
+
+  def auth_url
+    "#{api_url}/authorize"
+  end
+
+  def headers_with_auth_creds
+    CTAAggregatorClient::API::Authenticator.default_headers.merge(
+      authorization: auth_info
+    )
+  end
+
+  def auth_info
+    "#{CTAAggregatorClient.configuration.api_key}:#{CTAAggregatorClient.configuration.api_secret}"
+  end
+end

data/spec/integration/advocacy_campaign_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe CTAAggregatorClient::AdvocacyCampaign do
+
+  it_behaves_like 'listable resource'
+  it_behaves_like 'findable resource'
+
+  context 'creation' do
+    campaign_attrs = {
+      title: 'Email Congressman - 1',
+      description: 'Voluptas delectus distinctio maiores consequatur aspernatur.',
+      browser_url: 'http://example.com/nya.lang',
+      origin_system: '5Calls',
+      featured_image_url: 'http://lorempixel.com/300/300',
+      action_type: 'email',
+      template: 'Eum itaque et nisi dolores assumenda ipsum. Voluptates qui aut nobis veniam maxime qui. Illum saepe eum corporis vero qui soluta aliquam.\nTemporibus reiciendis velit fugiat. Facere laborum quia ea laboriosam necessitatibus quisquam eligendi. Et est dolorem eligendi id aut sint.\nAnimi qui totam voluptatem nesciunt iure et dolorem. Eos ut dolorum et quo illum fuga atque. Facere a ipsa corrupti assumenda provident commodi facilis. Eligendi officia est et.',
+    }
+    relationship_attrs = { targets: ['a2f6f86b-a214-4892-8c06-8caece820fb0', '215ed993-3cd1-4fbc-b8af-7e2082813d06'] }
+
+    it_behaves_like 'creatable resource', campaign_attrs, relationship_attrs
+  end
+end

data/spec/integration/events_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe CTAAggregatorClient::Event do
+
+  it_behaves_like 'listable resource'
+  it_behaves_like 'findable resource'
+  context 'creation' do
+    event_attrs = {
+      title: 'March on Washington',
+      description: 'Illum molestiae aut ullam non qui consequatur magni.',
+      browser_url: 'http://example.com/marge',
+      origin_system: '5Calls',
+      featured_image_url: 'http://lorempixel.com/300/300',
+      start_date: '2017-07-08T03:58:25.098Z',
+      end_date: '2017-07-13T03:58:25.098Z',
+      free: false,
+    }
+    relationship_attrs = { location: '215ed993-3cd1-4fbc-b8af-7e2082813d06' }
+
+    it_behaves_like 'creatable resource', event_attrs, relationship_attrs
+  end
+
+end

data/spec/integration/location_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CTAAggregatorClient::Location do
+
+  it_behaves_like 'listable resource'
+  it_behaves_like 'findable resource'
+  context 'creation' do
+    attributes = {
+      venue: 'Eastern Kemmer University',
+      address_lines: ['684 Schinner Trail', 'Apt. 512'],
+      locality: 'Rosenbaumville',
+      region: 'VA',
+      postal_code: '78183-3430'
+    }
+    it_behaves_like 'creatable resource', attributes
+  end
+
+end

data/spec/integration/target_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe CTAAggregatorClient::Target do
+
+  it_behaves_like 'listable resource'
+  it_behaves_like 'findable resource'
+
+  context 'creation' do
+    attributes = {
+      organization: 'Mohr Inc',
+      given_name: 'Pascale',
+      family_name: 'White',
+      ocdid: 'b4503418-6aab-451a-8e55-11ffd575bc85',
+      postal_addresses: [
+        {
+          primary: true,
+          address_type: 'Office',
+          venue: 'Southern Nitzsche',
+          address_lines: [
+            '36261 Kovacek Prairie',
+            'Apt. 760'
+
+          ],
+          locality: 'West Brandynfort',
+          region: 'WV',
+          postal_code: '66900-1309',
+          country: 'US'
+        }
+      ],
+      email_addresses: [
+        {
+          primary: true,
+          address: 'jeffry_durgan@rutherfordcarroll.net',
+          address_type: 'work'
+        }
+
+      ],
+      phone_numbers: [
+        {
+          primary: true,
+          number: '(606) 087-8543 x254',
+          extension: '4594',
+          number_type: 'work'
+        }
+      ]
+    }
+    it_behaves_like 'creatable resource', attributes
+  end
+end

data/spec/shared_examples/creatable_resource.rb

@@ -0,0 +1,108 @@
+shared_examples_for "creatable resource" do |passed_attrs, passed_relationships, resource|
+  let(:response) { Factory.response }
+  let(:auth_response) { Factory.auth_response }
+  let(:token) { Factory.token }
+
+  def relationships(relationship_hash)
+    return {} unless relationship_hash
+    relationship_hash.each_with_object({}) do |(resource_name, uuid_data), obj|
+      if uuid_data.is_a? Array
+        obj[resource_name.to_sym] = {
+          data: uuid_data.map {  |uuid| { type: resource_name, id: uuid } }
+        }
+      else
+        obj[resource_name.to_sym] = {
+          data: { type: "#{resource_name}s", id: uuid_data }
+        }
+      end
+    end
+  end
+
+  context 'with successful authentication' do
+
+    after do
+      CTAAggregatorClient::API::Authenticator.reset_auth
+    end
+
+    it 'create new record' do
+      resource_name = formatted_resource_name(described_class, resource)
+
+      url = "#{api_url}/#{resource_name}"
+
+      payload = {
+        'data': {
+          'type': resource_name,
+          'attributes': passed_attrs,
+          'relationships': relationships(passed_relationships)
+        }.reject{ |k,v| v.empty? }
+      }
+
+      allow(RestClient).to receive(:post).with(
+        auth_url,
+        nil,
+        headers_with_auth_creds
+      ).and_return(auth_response)
+
+      headers_with_auth_token = CTAAggregatorClient::API::Client.default_headers.merge(
+        authorization: "Bearer: #{token}"
+      )
+
+      expect(RestClient).to receive(:post).with(
+        url,
+        payload.to_json,
+        headers_with_auth_token
+      ).and_return(response)
+
+      expect(described_class.create(passed_attrs, passed_relationships)).to eq response
+    end
+  end
+
+  context 'with unsuccessful authentication' do
+    before do
+      CTAAggregatorClient.configure do |config|
+        config.api_key = 'bad_key'
+        config.api_secret = 'bad_secret'
+      end
+    end
+
+    after do
+      CTAAggregatorClient::API::Authenticator.reset_auth
+    end
+
+    it 'fails when auth creds wrong' do
+      resource_name = formatted_resource_name(described_class, resource)
+
+      url = "#{api_url}/#{resource_name}"
+      payload = {
+        'data': {
+          'type': resource_name,
+          'attributes': passed_attrs,
+          'relationships': relationships(passed_relationships)
+        }.reject{ |k,v| v.empty? }
+      }
+
+      headers_with_auth_creds = CTAAggregatorClient::API::Client.default_headers.merge(
+        authorization: "#{'bad_key'}:#{'bad_secret'}"
+      )
+
+      allow(RestClient).to receive(:post).with(
+        auth_url,
+        nil,
+        headers_with_auth_creds
+      ).and_return(Factory.bad_auth_response)
+
+      header_sans_auth_token = CTAAggregatorClient::API::Client.default_headers.merge(
+        authorization: "Bearer: #{nil}"
+      )
+
+      expect(RestClient).to receive(:post).with(
+        url,
+        payload.to_json,
+        header_sans_auth_token
+      ).and_return(Factory.bad_token_response)
+
+      expect(described_class.create(passed_attrs, passed_relationships).code).to eq 401
+    end
+  end
+
+end

data/spec/shared_examples/findable_resource.rb

@@ -0,0 +1,15 @@
+shared_examples_for "findable resource" do |resource|
+  let(:response) { Factory.response }
+
+  it 'find record' do
+    uuid = '123'
+
+    url = "#{api_url}/#{formatted_resource_name(described_class, resource)}/#{uuid}"
+    expect(RestClient).to receive(:get).with(
+      url,
+      CTAAggregatorClient::API::Client.default_headers
+    ).and_return(response)
+
+    expect(described_class.find(uuid)).to eq response
+  end
+end

data/spec/shared_examples/listable_resource.rb

@@ -0,0 +1,26 @@
+shared_examples_for "listable resource" do |resource|
+  let(:response) { Factory.response }
+
+  it 'with no filtering criterial' do
+    url = "#{api_url}/#{formatted_resource_name(described_class, resource)}"
+
+    expect(RestClient).to receive(:get).with(
+      url,
+      {headers: CTAAggregatorClient::API::Client.default_headers, params: {filter:  {}}}
+    ).and_return(response)
+
+    expect(described_class.list).to eq response
+  end
+
+  it 'with filtering' do
+    url = "#{api_url}/#{formatted_resource_name(described_class, resource)}"
+    filters = {foo: :bar}
+
+    expect(RestClient).to receive(:get).with(
+      url,
+      {headers: CTAAggregatorClient::API::Client.default_headers, params: {filter:  filters}}
+    ).and_return(response)
+
+    expect(described_class.list(filters)).to eq response
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'cta_aggregator_client'
+require 'shared_examples/listable_resource'
+require 'shared_examples/findable_resource'
+require 'shared_examples/creatable_resource'
+require 'helpers/test_helpers'
+require 'factory'
+require 'pry'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    CTAAggregatorClient.configure do |config|
+      config.base_url = 'localhost'
+      config.api_version = 'v1'
+      config.api_key = 'key'
+      config.api_secret = 'secret'
+    end
+  end
+
+  config.raise_errors_for_deprecations!
+
+  config.order = 'random'
+
+  config.include TestHelpers
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: cta_aggregator_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Downey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: 
+email: ben@buildingblocklabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cta_aggregator_client.rb
+- lib/cta_aggregator_client/advocacy_campaign.rb
+- lib/cta_aggregator_client/api/authenticator.rb
+- lib/cta_aggregator_client/api/client.rb
+- lib/cta_aggregator_client/api/utilities.rb
+- lib/cta_aggregator_client/configuration.rb
+- lib/cta_aggregator_client/cta_resource.rb
+- lib/cta_aggregator_client/event.rb
+- lib/cta_aggregator_client/location.rb
+- lib/cta_aggregator_client/response.rb
+- lib/cta_aggregator_client/target.rb
+- lib/cta_aggregator_client/version.rb
+- spec/factory.rb
+- spec/helpers/test_helpers.rb
+- spec/integration/advocacy_campaign_spec.rb
+- spec/integration/events_spec.rb
+- spec/integration/location_spec.rb
+- spec/integration/target_spec.rb
+- spec/shared_examples/creatable_resource.rb
+- spec/shared_examples/findable_resource.rb
+- spec/shared_examples/listable_resource.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Ragtagteam/cta-aggregator-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby Client for CTA Aggregator
+test_files:
+- spec/factory.rb
+- spec/helpers/test_helpers.rb
+- spec/integration/advocacy_campaign_spec.rb
+- spec/integration/events_spec.rb
+- spec/integration/location_spec.rb
+- spec/integration/target_spec.rb
+- spec/shared_examples/creatable_resource.rb
+- spec/shared_examples/findable_resource.rb
+- spec/shared_examples/listable_resource.rb
+- spec/spec_helper.rb