engaging-networks-rest 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a101e8d9b06d5978ebd2c4dd6fb143b45d394e137c8e1f3bedbcf15c328e7c67
-  data.tar.gz: 0d1ba97c6987799cf9dc9f451bbe1b4a2d0911687f83cb06d50b3c55ad5d694e
+  metadata.gz: 25a126fa7b16483ced7dfe2a92d73813f676c66e9023ac0441a511dca1a2cf2f
+  data.tar.gz: 3455f32e368b6f49915fb5429de01e62c2fa9514740e767ba4a43f02609f277f
 SHA512:
-  metadata.gz: ed34e204939951c9982b7755628bf89286f5ec62070cf0eb4b19f2fd2de53242f06a2b09d1a42c32e08879c73d7bd0c7c89bf5c8206b5bf58b073e2c3588e218
-  data.tar.gz: e3126e27996c77826e3e552bbe27bd316d53dbf953dfd59b01271132e412fc8a252798ab6dc4dc88dd4d1d3b84c43ee594d665115553bbc173600d5a542ac6ee
+  metadata.gz: 79c178cdc855862dd88c2393c20f08f3b58b65560fa46281c968945c9cd35423c0452588c5ff4b0f2fcd503f4edb2f0f3c28bd366b34d02b4fbaca49c07e1879
+  data.tar.gz: 9db9deb4c6b0d183697c8c209bbd8c0d69375f961b456a4ba3d93d3a4df8381e825dbaeea22d320cf5209992cd3b62859364979dc7e4b9a2e6078f37abfbc916

data/Gemfile

@@ -1,6 +1,12 @@
 source "https://rubygems.org"
 
+gem 'faraday', '~> 0.15'
+
 group :development do
   gem 'rspec', '>= 0'
   gem 'juwelier', '~> 2.1.0'
+  gem 'webmock', '~> 3.4'
+  gem 'faker', '~> 1.9'
+  gem 'pry-byebug', '~> 3.6'
+  gem 'faraday-detailed_logger', '~> 2.1', '>= 2.1.2'
 end

data/README.md

@@ -1,2 +1,22 @@
 # engaging-networks-rest
 Client gem for the ENS API to Engaging Networks
+
+## Install
+
+`gem install engaging-networks-rest`
+
+## Usage
+
+```
+client = EngagingNetworksRest.new(api_key: 'YOUR API KEY HERE')
+
+# get pages by type
+pages = client.pages(type: 'dcf', status: 'live')
+
+# process a page request
+response = client.process_page_request(page_id: 12345, body: {supporter: {first_name: 'Alice'}})
+```
+
+The client will call authentication endpoint behind the scenes the first time it makes a request.
+Currently, it does not attempt to check if its token is still valid for later requests.
+It is possible to force re-authentication with `client.authenticate!`.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/engaging-networks-rest.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: engaging-networks-rest 0.1.0 ruby lib
+# stub: engaging-networks-rest 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "engaging-networks-rest".freeze
-  s.version = "0.1.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jacinda Moore".freeze]
-  s.date = "2018-12-06"
+  s.date = "2019-01-08"
   s.description = "Client gem for the ENS API to Engaging Networks".freeze
   s.email = "jacinda@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
@@ -29,26 +29,47 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "engaging-networks-rest.gemspec",
-    "lib/engaging_networks_rest.rb"
+    "example.rb",
+    "lib/engaging_networks_rest.rb",
+    "lib/engaging_networks_rest/client.rb",
+    "lib/engaging_networks_rest/client/pages.rb",
+    "spec/client/pages_spec.rb",
+    "spec/client_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/controlshift/engaging-networks-rest".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.6".freeze
+  s.rubygems_version = "2.7.7".freeze
   s.summary = "Client gem for the ENS API to Engaging Networks".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<faraday>.freeze, ["~> 0.15"])
       s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_development_dependency(%q<webmock>.freeze, ["~> 3.4"])
+      s.add_development_dependency(%q<faker>.freeze, ["~> 1.9"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+      s.add_development_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
     else
+      s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
       s.add_dependency(%q<rspec>.freeze, [">= 0"])
       s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
+      s.add_dependency(%q<faker>.freeze, ["~> 1.9"])
+      s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+      s.add_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
     end
   else
+    s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
     s.add_dependency(%q<rspec>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+    s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
+    s.add_dependency(%q<faker>.freeze, ["~> 1.9"])
+    s.add_dependency(%q<pry-byebug>.freeze, ["~> 3.6"])
+    s.add_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2", "~> 2.1"])
   end
 end
 

data/example.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+
+require 'engaging_networks_rest'
+require 'faraday/detailed_logger'
+require 'byebug'
+
+def instrument_connection_with_extended_logging(client)
+  default_options = {
+    headers: {
+      'Accept' => "application/json;q=0.1",
+      'Accept-Charset' => "utf-8"
+    }
+  }
+
+  faraday_builder = ->(faraday) do
+    faraday.response :detailed_logger
+    faraday.adapter Faraday.default_adapter
+  end
+
+  instrumented_connection = Faraday.new(
+    default_options.merge(url: "https://#{EngagingNetworksRest::Client::ENS_DOMAIN}"),
+    &faraday_builder
+  )
+  client.instance_variable_set(:@connection, instrumented_connection)
+end
+
+client = EngagingNetworksRest.new(api_key: ENV['EN_API_KEY'])
+instrument_connection_with_extended_logging(client)
+
+byebug
+
+puts "Bye!"

data/lib/engaging_networks_rest/client/pages.rb

@@ -0,0 +1,22 @@
+module EngagingNetworksRest
+  class Client
+    module Pages
+      def pages(type:, status: nil)
+        filter_params = {'type' => type}
+        unless status.nil?
+          filter_params['status'] = status
+        end
+
+        get(path: "/ens/service/page", params: filter_params)
+      end
+
+      def page(page_id:)
+        get(path: "/ens/service/page/#{page_id}")
+      end
+
+      def process_page_request(page_id:, supporter_data:)
+        post(path: "/ens/service/page/#{page_id}/process", body: {supporter: supporter_data})
+      end
+    end
+  end
+end

data/lib/engaging_networks_rest/client.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'json'
+require 'engaging_networks_rest/client/pages'
+
+module EngagingNetworksRest
+  class Client
+    attr_reader :api_key, :connection, :ens_auth_key
+
+    ENS_DOMAIN = 'www.e-activist.com'.freeze
+
+    def initialize(api_key:)
+      @api_key = api_key
+
+      @connection = Faraday.new(url: "https://#{ENS_DOMAIN}")
+    end
+
+    def authenticate!
+      response = connection.post do |req|
+        req.url '/ens/service/authenticate'
+        req.headers['Content-Type'] = 'application/json'
+        req.body = api_key
+      end
+
+      parsed_body = JSON.parse(response.body)
+      @ens_auth_key = parsed_body['ens-auth-token']
+    end
+
+    def authenticated?
+      !ens_auth_key.nil?
+    end
+
+    def get(path:, params: {})
+      request(method: :get, path: path, params: params)
+    end
+
+    def post(path:, body: {})
+      request(method: :post, path: path, body: body)
+    end
+
+    include EngagingNetworksRest::Client::Pages
+
+    private
+
+    def request(method:, path:, params: {}, body: {})
+      unless authenticated?
+        authenticate!
+      end
+
+      response = connection.send(method) do |req|
+        req.path = path
+        req.params = params
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['ens-auth-token'] = ens_auth_key
+        req.body = ::JSON.generate(body) unless body.empty?
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/engaging_networks_rest.rb

@@ -0,0 +1,9 @@
+require 'engaging_networks_rest/client'
+
+module EngagingNetworksRest
+  class << self
+    def new(api_key:)
+      EngagingNetworksRest::Client.new(api_key: api_key)
+    end
+  end
+end

data/spec/client/pages_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe EngagingNetworksRest::Client::Pages do
+  let(:api_key) { 'abc-123' }
+  let(:ens_auth_key) { 'tmp-auth-key-456' }
+  let(:standard_headers) { {'Content-Type' => 'application/json', 'ens-auth-token' => ens_auth_key} }
+
+  subject { EngagingNetworksRest::Client.new(api_key: api_key) }
+
+  describe '#pages' do
+    let(:page_type) { 'dcf' }
+    let(:page_status) { 'live' }
+    let(:pages_url) { "https://#{EngagingNetworksRest::Client::ENS_DOMAIN}/ens/service/page" }
+
+    # The API docs don't actually say what this response looks like, so this is a guess.
+    # Fortunately, it doesn't actually matter for our purposes, since we just return whatever JSON we get.
+    let(:response) { [{'id' => 123, 'title' => 'A page'}, {'id' => 234, 'title' => 'Another page'}] }
+
+    shared_examples_for 'list pages' do
+      it 'should get pages' do
+        stub_request(:get, pages_url).with(headers: standard_headers, query: {'type' => page_type, 'status' => page_status})
+          .to_return(body: response.to_json)
+
+        expect(subject.pages(type: page_type, status: page_status)).to eq response
+      end
+
+      it 'should omit status param if not specified' do
+        stub_request(:get, pages_url).with(headers: standard_headers, query: {'type' => page_type})
+          .to_return(body: response.to_json)
+
+        expect(subject.pages(type: page_type)).to eq response
+      end
+    end
+
+    context 'not already authenticated' do
+      before :each do
+        expect(subject).to receive(:authenticate!) do
+          allow(subject).to receive(:ens_auth_key).and_return(ens_auth_key)
+        end
+      end
+
+      include_examples 'list pages'
+    end
+
+    context 'already authenticated' do
+      before :each do
+        allow(subject).to receive(:ens_auth_key).and_return(ens_auth_key)
+      end
+
+      include_examples 'list pages'
+    end
+  end
+
+  describe '#process_page_request' do
+    let(:page_id) { 234 }
+    let(:page_req_url) { "https://#{EngagingNetworksRest::Client::ENS_DOMAIN}/ens/service/page/#{page_id}/process" }
+    let(:email) { Faker::Internet.email }
+    let(:supporter_hash) { {'firstName' => 'Joe', 'lastName' => 'Smith', 'emailAddress' => email, 'customField1' => 'foo'} }
+    let(:response) { {'id' => '1234567', 'status' => 'SUCCESS', 'supporterEmailAddress' => email, 'supporterId' => '98765'} }
+
+    shared_examples_for 'process page request' do
+      it 'should process the page request' do
+        stub_request(:post, page_req_url).with(body: {supporter: supporter_hash}.to_json, headers: standard_headers)
+          .to_return(body: response.to_json)
+
+        expect(subject.process_page_request(page_id: page_id, body: {supporter: supporter_hash})).to eq response
+      end
+    end
+
+    context 'not already authenticated' do
+      before :each do
+        expect(subject).to receive(:authenticate!) do
+          allow(subject).to receive(:ens_auth_key).and_return(ens_auth_key)
+        end
+      end
+
+      include_examples 'process page request'
+    end
+
+    context 'already authenticated' do
+      before :each do
+        allow(subject).to receive(:ens_auth_key).and_return(ens_auth_key)
+      end
+
+      include_examples 'process page request'
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe EngagingNetworksRest::Client do
+  let(:api_key) { 'abc123' }
+  let(:content_type_header) { {'Content-Type' => 'application/json'} }
+
+  subject { EngagingNetworksRest::Client.new(api_key: api_key) }
+
+  describe '#authenticate!' do
+    let(:auth_url) { "https://#{EngagingNetworksRest::Client::ENS_DOMAIN}/ens/service/authenticate" }
+    let(:auth_key) { '75491e42-99dc-45ce-b637-a681bede875c' }
+    let(:auth_key_body) { "{\"ens-auth-token\":\"#{auth_key}\",\"expires\":3600000}" }
+
+    before :each do
+      stub_request(:post, auth_url).with(body: api_key, headers: content_type_header).to_return(body: auth_key_body)
+    end
+
+    it 'should set the ens_auth_key on the client' do
+      subject.authenticate!
+
+      expect(subject.ens_auth_key).to eq auth_key
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'faker'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'engaging_networks_rest'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+
+  config.before :each do
+    WebMock.reset!
+  end
+
+  config.after :each do
+    WebMock.reset!
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: engaging-networks-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacinda Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,68 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: faraday-detailed_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Client gem for the ENS API to Engaging Networks
 email: jacinda@controlshiftlabs.com
 executables: []
@@ -56,7 +132,13 @@ files:
 - Rakefile
 - VERSION
 - engaging-networks-rest.gemspec
+- example.rb
 - lib/engaging_networks_rest.rb
+- lib/engaging_networks_rest/client.rb
+- lib/engaging_networks_rest/client/pages.rb
+- spec/client/pages_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/controlshift/engaging-networks-rest
 licenses:
 - MIT
@@ -77,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Client gem for the ENS API to Engaging Networks