engaging-networks-rest 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4c75c9409376d414dc63d78307aa86b764c036a93b007590137f85794c1980
-  data.tar.gz: 46e773a7635d878fe9115b66e1a7a395e0efd287ed1532c73b347c7e6e027cca
+  metadata.gz: 50d7f225fefc60a2c7aca2d2bc17c290a0a483548d86b78cb138b1333a131c09
+  data.tar.gz: e172253dbccf464fa9f8862e0dcb5afd3802cc5745f1dd7a79fe4fdfc8981d9a
 SHA512:
-  metadata.gz: a4ae62b058d6ef1589226b0f82150da4cd45ef641f617dc967ff500b1529ba18137f098ee5e95054ed5ea0e4bdd0c42c868d5b37436960692df280a5939213e9
-  data.tar.gz: 6b2e2241bbc45fe002587341cfe792b826f403755d8c5b77efb226595c7e325cbb95745ee306a259e778fc4a54919ba87c9ce88e68c5dacd9ba8095fabe445a2
+  metadata.gz: 5363d9b2582910b3b54a69eff21226508fe39986a89103f73676ffc5b18436a7d787b3890940e7d1a7d2b8d803534507ba2cdd2b1c3d2531cc2de1409b05f2de
+  data.tar.gz: 0efb3821b1caf980c4a56c2acf87fc2814721e8e7206bcfb853e22de59798a16d48ea3a66b8506b8e781bdd6174bc48ee395da3eb218e49287eeb14035813986

data/.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['3.1', '3.2']
 
     steps:
       - uses: actions/checkout@v2
@@ -23,7 +23,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['3.1', '3.2']
 
     steps:
       - uses: actions/checkout@v2

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/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.1.4

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 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

data/Gemfile

@@ -2,17 +2,5 @@
 
 source 'https://rubygems.org'
 
-gem 'faraday', '>= 1.0'
-gem 'faraday_middleware'
-
-group :development do
-  gem 'faker', '> 1.9'
-  gem 'psych', '3.3.2'  # See https://github.com/faker-ruby/faker/issues/2330
-
-  gem 'faraday-detailed_logger', '>= 2.1.2'
-  gem 'juwelier', git: 'https://github.com/flajann2/juwelier.git'
-  gem 'pry-byebug', '> 3.6'
-  gem 'rspec', '>= 0'
-  gem 'rubocop'
-  gem 'webmock', '> 3.4'
-end
+# Gem's dependencies are specified in engaging-networks-rest.gemspec
+gemspec

data/Rakefile

@@ -11,21 +11,6 @@ rescue Bundler::BundlerError => e
 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 = %(Client gem for the ENS API to Engaging Networks)
-  gem.description = %(Client gem for the ENS API to Engaging Networks)
-  gem.email = 'grey@controlshiftlabs.com'
-  gem.authors = ['Grey Moore']
-
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-
 require 'rspec/core/rake_task'
 desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|

data/VERSION

@@ -1 +1 @@
-0.7.0
+1.0.0

data/engaging-networks-rest.gemspec

@@ -1,77 +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.7.0 ruby lib
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name = "engaging-networks-rest".freeze
-  s.version = "0.7.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 = ["Grey Moore".freeze]
-  s.date = "2023-10-16"
+  s.date = "2023-10-17"
   s.description = "Client gem for the ENS API to Engaging Networks".freeze
-  s.email = "grey@controlshiftlabs.com".freeze
+  s.email = "systems@controlshiftlabs.com".freeze
   s.extra_rdoc_files = [
     "LICENSE",
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    ".github/workflows/ci.yml",
-    ".rubocop.yml",
-    ".ruby-gemset",
-    ".ruby-version",
-    "CHANGELOG.md",
-    "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.1.6".freeze
   s.summary = "Client gem for the ENS API to Engaging Networks".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
   end
 
-  if s.respond_to? :add_runtime_dependency then
-    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, ["> 1.9"])
-    s.add_development_dependency(%q<psych>.freeze, ["= 3.3.2"])
-    s.add_development_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2"])
-    s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
-    s.add_development_dependency(%q<pry-byebug>.freeze, ["> 3.6"])
-    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"])
-  else
-    s.add_dependency(%q<faraday>.freeze, [">= 1.0"])
-    s.add_dependency(%q<faraday_middleware>.freeze, [">= 0"])
-    s.add_dependency(%q<faker>.freeze, ["> 1.9"])
-    s.add_dependency(%q<psych>.freeze, ["= 3.3.2"])
-    s.add_dependency(%q<faraday-detailed_logger>.freeze, [">= 2.1.2"])
-    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-    s.add_dependency(%q<pry-byebug>.freeze, ["> 3.6"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-    s.add_dependency(%q<webmock>.freeze, ["> 3.4"])
-  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/lib/engaging_networks_rest/client.rb

@@ -9,9 +9,7 @@ module EngagingNetworksRest
   class Client
     attr_reader :api_key, :connection, :ens_auth_key
 
-    ENS_DOMAIN = 'www.e-activist.com'
-
-    def initialize(api_key:, host: ENS_DOMAIN)
+    def initialize(api_key:, host:)
       @api_key = api_key
 
       @connection = Faraday.new(url: "https://#{host}") do |conn|
@@ -40,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

data/lib/engaging_networks_rest.rb

@@ -4,8 +4,8 @@ require 'engaging_networks_rest/client'
 
 module EngagingNetworksRest
   class << self
-    def new(api_key:, host: EngagingNetworksRest::Client::ENS_DOMAIN)
-      EngagingNetworksRest::Client.new(api_key: api_key, host: host)
+    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.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,28 +44,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.3.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
-  name: juwelier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: debug
   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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.4'
 description: Client gem for the ENS API to Engaging Networks
-email: grey@controlshiftlabs.com
+email: systems@controlshiftlabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -160,6 +132,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".github/workflows/ci.yml"
+- ".gitignore"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -176,10 +149,7 @@ 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: {}
@@ -198,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Client gem for the ENS API to Engaging Networks

data/spec/client/pages_spec.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-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) do
-      { 'firstName' => 'Joe', 'lastName' => 'Smith', 'emailAddress' => email, 'customField1' => 'foo' }
-    end
-    let(:response) do
-      { 'id' => '1234567', 'status' => 'SUCCESS', 'supporterEmailAddress' => email, 'supporterId' => '98765' }
-    end
-    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)
-
-        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 do
-          subject.process_page_request(page_id: page_id,
-                                       supporter_data: supporter_hash)
-        end.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,44 +0,0 @@
-# frozen_string_literal: true
-
-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_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
-
-    context 'with no host specified' do
-      let(:auth_url) { "https://#{EngagingNetworksRest::Client::ENS_DOMAIN}/ens/service/authenticate" }
-
-      it 'should set the ens_auth_key on the client' do
-        subject.authenticate!
-
-        expect(subject.ens_auth_key).to eq auth_key
-      end
-    end
-
-    context 'with a host specified' do
-      let(:host) { 'example.com' }
-      let(:auth_url) { "https://#{host}/ens/service/authenticate" }
-
-      subject { EngagingNetworksRest::Client.new(api_key: api_key, host: host) }
-
-      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
-end

data/spec/spec_helper.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-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