action_network_rest 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b7b240942768a53e1147e7fffa36b885b26fb18dd6f776840b94ce8dc49e55
-  data.tar.gz: 30a574c7f97c5d24821705a26c3342d54cb19b51e3c5c8ea5675562457575067
+  metadata.gz: 37c51a40b6924bf886e768ec83816bbe33d0a9cbd006c995631d5ddf1248b677
+  data.tar.gz: 0a4506ccdd24760312a0149f4d5e363d99c4a27d21a6b11537ce059f3c637830
 SHA512:
-  metadata.gz: dff8444e27578df2e68ab63a794dac3404b3b2c6cea64f1b1ef79d75b1ebc4a66ac513a47f8e08c8a434587b09fb7af2b1121c52a6ee929a45440d2841ead784
-  data.tar.gz: 1008be4924275825b9b31c520259d33b538543db9c8ea0a37e0bd672d2ebfdf2a48704689ad579c3271e0331b30a4f7336836d40deb811ece18b10716b8a2dde
+  metadata.gz: e52d89573de10a3963b5f14da3269beb6568a3090bf975c419c6f641a62f090277ec3fcc4d9c22be13f3160ab4d2be7f256b106379339ce8e16f4c8c06b109b4
+  data.tar.gz: 366ab08d1f91e871414a6b721ca846ab17ecaf87e2ed6c344d144bd8e9004cc6574af5dcdfc95b217aec7a0d17cb02cc50f4d01cc3b86d76e3bd09dc1c2e16cb

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+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
+  rubocop:
+    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 rubocop

data/.rubocop.yml

@@ -4,8 +4,12 @@ require:
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
+Metrics/AbcSize:
+  Enabled: false
 Metrics/BlockLength:
   Enabled: false
+Metrics/MethodLength:
+  Enabled: false
 Naming/AccessorMethodName:
   Enabled: false
 Naming/MemoizedInstanceVariableName:

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+2.7.4

data/README.md

@@ -2,7 +2,7 @@
 
 Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/) from the engineering team at [ControlShift](https://www.controlshiftlabs.com/).
 
-[![Build Status](https://travis-ci.org/controlshift/action-network-rest.svg?branch=master)](https://travis-ci.org/controlshift/action-network-rest)
+[![CI Status](https://github.com/controlshift/action-network-rest/actions/workflows/ci.yml/badge.svg)](https://github.com/controlshift/action-network-rest/actions/workflows/ci.yml)
 
 ## Installation
 

data/lib/action_network_rest/api.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class API < Vertebrae::API
+    def setup
+      connection.stack do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseJson
+
+        builder.use ActionNetworkRest::Response::RaiseError
+        builder.adapter connection.configuration.adapter
+      end
+    end
+  end
+end

data/lib/action_network_rest/attendances.rb

@@ -2,6 +2,8 @@
 
 module ActionNetworkRest
   class Attendances < Base
+    class CreateError < StandardError; end
+
     attr_accessor :event_campaign_id, :event_id
 
     def base_path
@@ -14,7 +16,15 @@ module ActionNetworkRest
 
     def create(attendance_data)
       response = client.post_request base_path, attendance_data
-      object_from_response(response)
+      new_attendance = object_from_response(response)
+
+      # Action Network treats the attendance create helper endpoint as an unauthenticated
+      # "blind" POST (see https://actionnetwork.org/docs/v2/unauthenticated-post/). For this
+      # reason they don't return a status code with error to avoid leaking private data. Instead
+      # they return 200 OK with an empty body (vs. the newly created attendance's data for successful calls)
+      raise CreateError if new_attendance.empty?
+
+      new_attendance
     end
 
     def update(id, attendance_data)

data/lib/action_network_rest/base.rb

@@ -23,7 +23,7 @@ module ActionNetworkRest
       CGI.escape(string.to_s)
     end
 
-    def set_action_network_id_on_object(obj)
+    def set_action_network_id_on_object(obj, action_network_id_required: false)
       # Takes an object which may contain an `identifiers` key, which may contain an action_network identifier
       # If so, we pull out the action_network identifier and stick it in a top-level key "action_network_id",
       # for the convenience of callers using the returned object.
@@ -38,14 +38,16 @@ module ActionNetworkRest
       end
       if qualified_actionnetwork_id.present?
         obj.action_network_id = qualified_actionnetwork_id.sub(/^action_network:/, '')
+      elsif action_network_id_required
+        raise ActionNetworkRest::Response::MissingActionNetworkId, obj.inspect
       end
 
       obj
     end
 
-    def object_from_response(response)
+    def object_from_response(response, action_network_id_required: false)
       obj = response.body
-      set_action_network_id_on_object(obj)
+      set_action_network_id_on_object(obj, action_network_id_required: action_network_id_required)
     end
 
     def action_network_url(path)

data/lib/action_network_rest/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ActionNetworkRest
-  class Client < Vertebrae::API
+  class Client < API
     attr_accessor :api_key
 
     def initialize(options = {}, &block)

data/lib/action_network_rest/event_campaigns.rb

@@ -20,6 +20,12 @@ module ActionNetworkRest
       object_from_response(response)
     end
 
+    def update(id, event_campaign_data)
+      event_campaign_path = "#{base_path}#{url_escape(id)}"
+      response = client.put_request event_campaign_path, event_campaign_data
+      object_from_response(response)
+    end
+
     def events(event_id = nil)
       @_events ||= ActionNetworkRest::Events.new(event_campaign_id: event_campaign_id, event_id: event_id,
                                                  client: client)

data/lib/action_network_rest/events.rb

@@ -32,7 +32,7 @@ module ActionNetworkRest
       end
 
       response = client.post_request(base_path, post_body)
-      object_from_response(response)
+      object_from_response(response, action_network_id_required: true)
     end
 
     def attendances

data/lib/action_network_rest/response/raise_error.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+      # rubocop:disable Style/GuardClause
+      def on_complete(response)
+        status_code = response[:status].to_i
+
+        if (400...600).cover? status_code
+          if status_code == 400 && response[:body].include?('error')
+            error_hsh = JSON.parse(response[:body])
+            error_message = error_hsh['error']
+
+            if error_message == 'You must specify a valid person id'
+              raise MustSpecifyValidPersonId, error_message(response)
+            end
+          elsif status_code == 404
+            raise NotFoundError, error_message(response)
+          else
+            raise ResponseError, error_message(response)
+          end
+        end
+      end
+      # rubocop:enable Style/GuardClause
+
+      def error_message(response)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]} \n\n #{response[:body]}"
+      end
+    end
+
+    class MissingActionNetworkId < StandardError; end
+
+    class MustSpecifyValidPersonId < StandardError; end
+
+    class NotFoundError < StandardError; end
+
+    class ResponseError < StandardError; end
+  end
+end

data/lib/action_network_rest/signatures.rb

@@ -2,6 +2,8 @@
 
 module ActionNetworkRest
   class Signatures < Base
+    class CreateError < StandardError; end
+
     attr_accessor :petition_id
 
     def base_path
@@ -13,7 +15,15 @@ module ActionNetworkRest
       post_body['add_tags'] = tags if tags.any?
 
       response = client.post_request(base_path, post_body)
-      object_from_response(response)
+      new_signature = object_from_response(response)
+
+      # Action Network treats the signature create helper endpoint as an unauthenticated
+      # "blind" POST (see https://actionnetwork.org/docs/v2/unauthenticated-post/). For this
+      # reason they don't return a status code with error to avoid leaking private data. Instead
+      # they return 200 OK with an empty body (vs. the newly created signature's data for successful calls)
+      raise CreateError if new_signature.empty?
+
+      new_signature
     end
 
     def update(id, signature_data)

data/lib/action_network_rest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionNetworkRest
-  VERSION = '0.8.0'
+  VERSION = '0.10.0'
 end

data/lib/action_network_rest.rb

@@ -13,6 +13,8 @@ module ActionNetworkRest
 end
 
 require 'action_network_rest/version'
+require 'action_network_rest/api'
+require 'action_network_rest/response/raise_error'
 require 'action_network_rest/client'
 require 'action_network_rest/base'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Grey Moore
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.3
-description: 
+description:
 email:
 - grey@controlshiftlabs.com
 executables: []
@@ -144,11 +144,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -160,6 +160,7 @@ files:
 - bin/rspec
 - example.rb
 - lib/action_network_rest.rb
+- lib/action_network_rest/api.rb
 - lib/action_network_rest/attendances.rb
 - lib/action_network_rest/base.rb
 - lib/action_network_rest/client.rb
@@ -168,6 +169,7 @@ files:
 - lib/action_network_rest/events.rb
 - lib/action_network_rest/people.rb
 - lib/action_network_rest/petitions.rb
+- lib/action_network_rest/response/raise_error.rb
 - lib/action_network_rest/signatures.rb
 - lib/action_network_rest/taggings.rb
 - lib/action_network_rest/tags.rb
@@ -176,7 +178,7 @@ homepage: https://github.com/controlshift/action-network-rest
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby client for interacting with the ActionNetwork REST API
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.7
-cache: bundler
-before_install:
-  - gem install bundler
-script:
-  - bundle exec rspec
-  - bundle exec rubocop