engaging-networks-rest 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3893669b39db25ea995ca69261faf534cfd5bc497928e1df6b5765d57315d1
-  data.tar.gz: 7f1e50fbb1831eb1c03b3bdb19bfbd1ea0af6828f1db3d4c92831c83ebe5c5db
+  metadata.gz: 50d7f225fefc60a2c7aca2d2bc17c290a0a483548d86b78cb138b1333a131c09
+  data.tar.gz: e172253dbccf464fa9f8862e0dcb5afd3802cc5745f1dd7a79fe4fdfc8981d9a
 SHA512:
-  metadata.gz: 684c2ddccb8c0f2b2206e33a01cb34d37094c43af7beab6d69aee6731e10595f620b9d76d800f0e10ca68128961bec1bfaf0f0814375bc3a6c653d922e5ac5be
-  data.tar.gz: 59f1ba47be552a66f24e931628945c26d147b716e87c7f280927a5ecf06e476d8d743c9bf3ced9eb2b3247724497e2a4c17592f1339c4056f9876678bef1ba47
+  metadata.gz: 5363d9b2582910b3b54a69eff21226508fe39986a89103f73676ffc5b18436a7d787b3890940e7d1a7d2b8d803534507ba2cdd2b1c3d2531cc2de1409b05f2de
+  data.tar.gz: 0efb3821b1caf980c4a56c2acf87fc2814721e8e7206bcfb853e22de59798a16d48ea3a66b8506b8e781bdd6174bc48ee395da3eb218e49287eeb14035813986

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea/
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Exclude:
+    - 'engaging-networks-rest.gemspec'
+    - 'example.rb'
+    - 'vendor/**/*'
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.4

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [1.0.0] - 2023-10-17
+
+### BREAKING CHANGES
+- Drops support for ruby versions 2.7 and 3.0. Only ruby 3.1 or newer is now supported.
+- `EngagingNetworksRest.new` and `EngagingNetworksRest::Client.new` now require the `host` parameter
+
+### Development changes
+- Removed juwelier. Dependencies are now managed only in the gemspec file.
+- Replaced byebug with debug
+- Upgraded required faker version to eliminate the need for pinning psych
+
+## [0.7.0] - 2023-10-16
+
+### Added
+- Adds support for passing a `host` parameter to EngagingNetworksRest.new and EngagingNetworksRest::Client.new
+- Ruby versions 3.0, 3.1, and 3.2 are officially supported in addition to ruby 2.7

data/Gemfile

@@ -1,13 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gem 'faraday', '>= 1.0'
-gem 'faraday_middleware'
+source 'https://rubygems.org'
 
-group :development do
-  gem 'rspec', '>= 0'
-  gem 'juwelier', git: 'https://github.com/flajann2/juwelier.git'
-  gem 'webmock', '> 3.4'
-  gem 'faker', '> 1.9'
-  gem 'pry-byebug', '> 3.6'
-  gem 'faraday-detailed_logger', '>= 2.1.2'
-end
+# Gem's dependencies are specified in engaging-networks-rest.gemspec
+gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Jacinda Moore
+Copyright (c) 2018 ControlShift Labs
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,8 @@
 # engaging-networks-rest
 Client gem for the ENS API to Engaging Networks
 
+[![CI Status](https://github.com/controlshift/engaging-networks-rest/actions/workflows/ci.yml/badge.svg)](https://github.com/controlshift/engaging-networks-rest/actions/workflows/ci.yml)
+
 ## Install
 
 `gem install engaging-networks-rest`
@@ -8,7 +10,7 @@ Client gem for the ENS API to Engaging Networks
 ## Usage
 
 ```
-client = EngagingNetworksRest.new(api_key: 'YOUR API KEY HERE')
+client = EngagingNetworksRest.new(api_key: 'YOUR API KEY HERE', host: 'us.engagingnetworks.app')
 
 # get pages by type
 pages = client.pages(type: 'dcf', status: 'live')

data/Rakefile

@@ -1,50 +1,35 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 
-require 'juwelier'
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "engaging-networks-rest"
-  gem.homepage = "http://github.com/controlshift/engaging-networks-rest"
-  gem.license = "MIT"
-  gem.summary = %Q{Client gem for the ENS API to Engaging Networks}
-  gem.description = %Q{Client gem for the ENS API to Engaging Networks}
-  gem.email = "jacinda@controlshiftlabs.com"
-  gem.authors = ["Jacinda Moore"]
-
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-
 require 'rspec/core/rake_task'
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.pattern = './spec/**/*_spec.rb' # don't need this, it's default.
   t.rspec_opts = '--color'
 end
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['test'].execute
 end
 
-desc 'Default: run specs.'
-task :default => :spec
+desc 'Default: run specs'
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "engaging-networks-rest #{version}"

data/VERSION

@@ -1 +1 @@
-0.6.0
+1.0.0

data/engaging-networks-rest.gemspec

@@ -1,79 +1,42 @@
-# Generated by juwelier
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: engaging-networks-rest 0.6.0 ruby lib
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name = "engaging-networks-rest".freeze
-  s.version = "0.6.0"
+  s.version = "1.0.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 = "2021-03-23"
+  s.authors = ["Grey Moore".freeze]
+  s.date = "2023-10-17"
   s.description = "Client gem for the ENS API to Engaging Networks".freeze
-  s.email = "jacinda@controlshiftlabs.com".freeze
+  s.email = "systems@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
     "LICENSE",
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    ".ruby-gemset",
-    ".ruby-version",
-    "Gemfile",
-    "LICENSE",
-    "LICENSE.txt",
-    "README.md",
-    "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",
-    "lib/engaging_networks_rest/response/raise_error.rb",
-    "spec/client/pages_spec.rb",
-    "spec/client_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/controlshift/engaging-networks-rest".freeze
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.homepage = 'https://github.com/controlshift/engaging-networks-rest'.freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.8".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, [">= 1.0"])
-      s.add_runtime_dependency(%q<faraday_middleware>.freeze, [">= 0"])
-      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 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"])
-    else
-      s.add_dependency(%q<faraday>.freeze, [">= 1.0"])
-      s.add_dependency(%q<faraday_middleware>.freeze, [">= 0"])
-      s.add_dependency(%q<rspec>.freeze, [">= 0"])
-      s.add_dependency(%q<juwelier>.freeze, [">= 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"])
-    end
-  else
-    s.add_dependency(%q<faraday>.freeze, [">= 1.0"])
-    s.add_dependency(%q<faraday_middleware>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<juwelier>.freeze, [">= 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"])
   end
-end
 
+  s.add_runtime_dependency(%q<faraday>.freeze, [">= 1.0"])
+  s.add_runtime_dependency(%q<faraday_middleware>.freeze, [">= 0"])
+
+  s.add_development_dependency(%q<faker>.freeze, ["> 2.20.0"])
+  s.add_development_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2"])
+  s.add_development_dependency(%q<debug>.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, ["> 3.4"])
+end

data/example.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 
 require 'engaging_networks_rest'
@@ -7,16 +9,16 @@ require 'byebug'
 def instrument_connection_with_extended_logging(client)
   default_options = {
     headers: {
-      'Accept' => "application/json;q=0.1",
-      'Accept-Charset' => "utf-8"
+      'Accept' => 'application/json;q=0.1',
+      'Accept-Charset' => 'utf-8'
     }
   }
 
-  faraday_builder = ->(faraday) do
+  faraday_builder = lambda do |faraday|
     faraday.request :json
-    faraday.response :json, :content_type => /\bjson$/
+    faraday.response :json, content_type: /\bjson$/
     faraday.use Faraday::Response::Logger if ENV['DEBUG']
-    faraday.use  EngagingNetworksRest::Response::RaiseError
+    faraday.use EngagingNetworksRest::Response::RaiseError
     faraday.response :detailed_logger
     faraday.adapter Faraday.default_adapter
   end
@@ -33,4 +35,4 @@ instrument_connection_with_extended_logging(client)
 
 byebug
 
-puts "Bye!"
+puts 'Bye!'

data/lib/engaging_networks_rest/client/pages.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module EngagingNetworksRest
   class Client
     module Pages
       def pages(type:, status: nil)
-        filter_params = {'type' => type}
-        unless status.nil?
-          filter_params['status'] = status
-        end
+        filter_params = { 'type' => type }
+        filter_params['status'] = status unless status.nil?
 
-        get(path: "/ens/service/page", params: filter_params)
+        get(path: '/ens/service/page', params: filter_params)
       end
 
       def page(page_id:)
@@ -15,10 +15,9 @@ module EngagingNetworksRest
       end
 
       def process_page_request(page_id:, supporter_data:, generic_data: {})
-        response = post(path: "/ens/service/page/#{page_id}/process", body: generic_data.merge(supporter: supporter_data))
-        if response['status'] == 'SUCCESS'
-          return response
-        end
+        response = post(path: "/ens/service/page/#{page_id}/process",
+                        body: generic_data.merge(supporter: supporter_data))
+        return response if response['status'] == 'SUCCESS'
 
         raise "Unexpected 'status' value on response: #{response}"
       end

data/lib/engaging_networks_rest/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'engaging_networks_rest/client/pages'
@@ -7,14 +9,12 @@ module EngagingNetworksRest
   class Client
     attr_reader :api_key, :connection, :ens_auth_key
 
-    ENS_DOMAIN = 'www.e-activist.com'.freeze
-
-    def initialize(api_key:)
+    def initialize(api_key:, host:)
       @api_key = api_key
 
-      @connection = Faraday.new(url: "https://#{ENS_DOMAIN}") do |conn|
+      @connection = Faraday.new(url: "https://#{host}") do |conn|
         conn.request :json
-        conn.response :json, :content_type => /\bjson$/
+        conn.response :json, content_type: /\bjson$/
 
         conn.use Faraday::Response::Logger if ENV['DEBUG']
         conn.use EngagingNetworksRest::Response::RaiseError
@@ -38,11 +38,11 @@ module EngagingNetworksRest
     end
 
     def get(path:, params: {})
-      request(method: :get, path: path, params: params)
+      request(method: :get, path:, params:)
     end
 
     def post(path:, body: {})
-      request(method: :post, path: path, body: body)
+      request(method: :post, path:, body:)
     end
 
     include EngagingNetworksRest::Client::Pages
@@ -50,9 +50,7 @@ module EngagingNetworksRest
     private
 
     def request(method:, path:, params: {}, body: {})
-      unless authenticated?
-        authenticate!
-      end
+      authenticate! unless authenticated?
 
       response = connection.send(method) do |req|
         req.headers['Content-Type'] = 'application/json'

data/lib/engaging_networks_rest/response/raise_error.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module EngagingNetworksRest
   module Response
-    class NotFound < StandardError ; end
-    class Unauthorized < StandardError ; end
+    class NotFound < StandardError; end
+
+    class Unauthorized < StandardError; end
+
     class InternalError < StandardError; end
 
     class RaiseError < Faraday::Response::Middleware
@@ -10,19 +14,19 @@ module EngagingNetworksRest
         if (400...600).include? status_code
           case status_code
           when 401
-            raise Unauthorized.new(error_message(response))
+            raise Unauthorized, error_message(response)
           when 404
-            raise NotFound.new(error_message(response))
+            raise NotFound, error_message(response)
           when 500
-            raise InternalError.new(error_message(response))
+            raise InternalError, error_message(response)
           else
-            raise StandardError.new(error_message(response))
+            raise StandardError, error_message(response)
           end
         end
       end
 
       def error_message(response)
-        "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]} \n\n #{response[:body] if response[:body]}"
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]} \n\n #{response[:body]}"
       end
     end
   end

data/lib/engaging_networks_rest.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: engaging-networks-rest
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Jacinda Moore
-autorequire:
+- Grey Moore
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,91 +39,91 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday-detailed_logger
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '3.4'
 description: Client gem for the ENS API to Engaging Networks
-email: jacinda@controlshiftlabs.com
+email: systems@controlshiftlabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -131,8 +131,12 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -145,14 +149,11 @@ files:
 - lib/engaging_networks_rest/client.rb
 - lib/engaging_networks_rest/client/pages.rb
 - lib/engaging_networks_rest/response/raise_error.rb
-- spec/client/pages_spec.rb
-- spec/client_spec.rb
-- spec/spec_helper.rb
-homepage: http://github.com/controlshift/engaging-networks-rest
+homepage: https://github.com/controlshift/engaging-networks-rest
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +168,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.26
+signing_key: 
 specification_version: 4
 summary: Client gem for the ENS API to Engaging Networks
 test_files: []

data/spec/client/pages_spec.rb

@@ -1,108 +0,0 @@
-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(status: '200', headers: {content_type: "application/json; charset=utf-8"}, 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(status: '200', headers: {content_type: "application/json; charset=utf-8"}, 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'} }
-    let(:failure_response) { {'status' => 'ERROR', 'message' => 'Something went wrong'} }
-
-    shared_examples_for 'process page request' do
-      it 'should send correct body for supporter and generic data' do
-        stub_request(:post, page_req_url)
-          .with(body: {'txn1' => 'foo', 'txn2' => 'bar', 'suppressAutoResponder' => true, supporter: { 'lastName' => 'Smith', 'emailAddress' => email }}.to_json, headers: standard_headers)
-          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: response.to_json)
-
-        result = subject.process_page_request(page_id: page_id, generic_data: { 'txn1' => 'foo', 'txn2' => 'bar', 'suppressAutoResponder' => true }, supporter_data: { 'lastName' => 'Smith', 'emailAddress' => email })
-      end
-
-      it 'should process the page request and return its ID' do
-        stub_request(:post, page_req_url).with(body: {supporter: supporter_hash}.to_json, headers: standard_headers)
-          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: response.to_json)
-
-        result = subject.process_page_request(page_id: page_id, supporter_data: supporter_hash)
-
-        expect(result['id']).to eq '1234567'
-        expect(result['supporterId']).to eq '98765'
-        expect(result['supporterEmailAddress']).to eq email
-      end
-
-      it 'should raise if response status is not SUCCESS' do
-        stub_request(:post, page_req_url).with(body: {supporter: supporter_hash}.to_json, headers: standard_headers)
-          .to_return(status: '200', headers: {content_type: "application/json; charset=utf-8"}, body: failure_response.to_json)
-
-        expect { subject.process_page_request(page_id: page_id, supporter_data: supporter_hash) }.to raise_error(RuntimeError, /Unexpected 'status' value on response.*Something went wrong/)
-      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

@@ -1,24 +0,0 @@
-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, headers: content_type_header)
-    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

@@ -1,19 +0,0 @@
-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