action_network_rest 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ad7612c6bccf090f5e717750753d3f47314b53b0a36d0b59907102f1dcd1eb
-  data.tar.gz: adddc2d4bb8bab60b0db1ebb4312651793e757f193f177c68562c2b96d57cdd2
+  metadata.gz: f9016ae9e2c22b78c042639d589683ff591c4098712cad0861dc8faab843c82a
+  data.tar.gz: 114f680aead1e7b3500c26fb61175784046bf68db57ac62137df455f98f1789e
 SHA512:
-  metadata.gz: f9e77003bda8400d416e299575383eb36c4d9aa43e8451abb29877e7fd329d5fad8dd58655137218525d351ae49e6b274e75f80e75db90a94161f4ac9eeb9f43
-  data.tar.gz: 171aa0166b8a8667f9ee1540ca5bdf3182401a9a7c91badd0bb701815d17e4f0ae22435da8e9202d636a25d7f9a3dd607272f13519238d0110cc4944e0f66021
+  metadata.gz: 7f811528d9ffe857652121e3c3bf42b517b9991a5335dd52fd99c02d36b3a75688bbc403c16aca0cdd619a4efc96fc3d5f50cb7d4fcddc2b01731c068c85e03b
+  data.tar.gz: b4db252bd30f7aeee2f3d402f287104212e51a7cf2e745773767d63f577a9d1c9131b4162b671b0568108b1b7d6e7e23434ed5d1016c949eb5e613238722c5fb

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/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

@@ -16,8 +16,22 @@ module ActionNetworkRest
       end
     end
 
-    def create(event_data)
-      response = client.post_request(base_path, event_data)
+    def create(event_data, creator_person_id: nil, organizer_person_id: nil)
+      post_body = event_data
+
+      if creator_person_id.present?
+        creator_person_url = action_network_url("/people/#{url_escape(creator_person_id)}")
+        post_body['_links'] ||= {}
+        post_body['_links']['osdi:creator'] = { href: creator_person_url }
+      end
+
+      if organizer_person_id.present?
+        organizer_person_url = action_network_url("/people/#{url_escape(organizer_person_id)}")
+        post_body['_links'] ||= {}
+        post_body['_links']['osdi:organizer'] = { href: organizer_person_url }
+      end
+
+      response = client.post_request(base_path, post_body)
       object_from_response(response)
     end
 
@@ -26,6 +40,12 @@ module ActionNetworkRest
                                                            event_campaign_id: event_campaign_id)
     end
 
+    def update(id, event_data)
+      event_path = "#{base_path}#{url_escape(id)}"
+      response = client.put_request event_path, event_data
+      object_from_response(response)
+    end
+
     private
 
     def osdi_key

data/lib/action_network_rest/response/raise_error.rb

@@ -0,0 +1,38 @@
+# 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 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.7.0'
+  VERSION = '0.9.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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -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

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