action_network_rest 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc85d83854d521199b82e855ee4369c66c076a8487753756cc454010a0a22907
-  data.tar.gz: 684db90a396a39ebbdc54ffec3fcdba678a2338fbc334052786f7422d4990eb9
+  metadata.gz: a6ad7612c6bccf090f5e717750753d3f47314b53b0a36d0b59907102f1dcd1eb
+  data.tar.gz: adddc2d4bb8bab60b0db1ebb4312651793e757f193f177c68562c2b96d57cdd2
 SHA512:
-  metadata.gz: fa5f2ece5e76ef8bfbffd96349eb0c545c423da441a318fab71458d86f7ebfd483a4bc7f512f25df73ad9a5f1acfc32a1f60e1acb69770f5b0c75b8b695420ec
-  data.tar.gz: '0897288683f87fc8a9a273d360bf01bbbcf0da24bf7d90ffbb1176299a79f376a01d55e57af7a7680a771c8787579f78353eb5d32a08b0691d131b76f4431b45'
+  metadata.gz: f9e77003bda8400d416e299575383eb36c4d9aa43e8451abb29877e7fd329d5fad8dd58655137218525d351ae49e6b274e75f80e75db90a94161f4ac9eeb9f43
+  data.tar.gz: 171aa0166b8a8667f9ee1540ca5bdf3182401a9a7c91badd0bb701815d17e4f0ae22435da8e9202d636a25d7f9a3dd607272f13519238d0110cc4944e0f66021

data/.env.sample

@@ -0,0 +1,2 @@
+# API key used on example.rb, you don't need to define this in the gem including code
+API_KEY=xyz

data/.gitignore

@@ -11,25 +11,12 @@
 /tmp/
 
 # Used by dotenv library to load environment variables.
-# .env
+.env
 
 # Ignore Byebug command history file.
 .byebug_history
 
-## 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:
@@ -56,3 +43,6 @@ Gemfile.lock
 # .rubocop-https?--*
 
 .rspec_status
+.DS_store
+.idea/
+.rakeTasks

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+Metrics/BlockLength:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.3

data/.travis.yml

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

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in action_network_rest.gemspec
 gemspec

data/README.md

@@ -1,6 +1,8 @@
 # ActionNetworkRest
 
-Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/)
+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)
 
 ## Installation
 
@@ -21,6 +23,8 @@ Or install it yourself as:
 ## Usage
 
 ```
+require 'action_network_rest'
+
 client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
 
 # Check that our API key is working. Returns true or false.
@@ -33,10 +37,29 @@ client.entry_point.get
 person = client.people.create(email_addresses: [{address: 'foo@example.com'}])
 person_id = person.action_network_id
 
+# List people
+people = client.people.list
+
+# Iterate over a list of people
+page_number = 1
+loop do
+  people = client.people.list(page: page_number)
+  break if people.empty?
+  page_number += 1
+end
+
 # Retrieve a Person's data
 person = client.people.get(person_id)
 puts person.email_addresses
 
+# Retrieve a Person's data by their email address
+person = client.people.find_by_email(person_email)
+person_id = person.action_network_id
+puts person.email_addresses
+
+# Update a Person
+client.people.update(person_id, {custom_fields: {custom_id: "12345"}})
+
 # Unsubscribe a Person
 client.people.unsubscribe(person_id)
 
@@ -63,6 +86,34 @@ puts signature.created_date
 
 # Update a Signature
 client.petitions(petition_id).signatures.update(signature_id, {comments: 'new comments'})
+
+# Create a Tag
+tag = client.tags.create('Volunteers')
+tag_id = tag.action_network_id
+
+# Retrieve a Tag
+tag = client.tags.get(tag_id)
+
+# Retrieve a Tag by name
+tag = client.tags.find_by_name('Volunteers')
+
+# Apply a Tag to a Person
+tagging = client.tags(tag_id).create({identifiers: ['external:123']}, person_id: person_id)
+tagging_id = tagging.action_network_id
+
+# Retrieve a Tagging
+tagging = client.tags(tag_id).taggings.get(tagging_id)
+
+# Delete a Tagging
+client.tags(tag_id).taggings.delete(tagging_id)
+
+# List Events in an Event Campaign
+event_campaign_id = '123e4567-e89b-12d3-a456-426614174000'
+client.event_campaigns(event_campaign_id).events.list
+
+# Add an Attendance
+event_id = '123e4567-e89b-12d3-a456-426655440000'
+client.events(event_id).attendances.create({ person: {email_addresses: [{address: 'alice@example.com'}]}})
 ```
 
 ## Development
@@ -71,6 +122,8 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To run a REPL with an initialized client object you'll need to create your own `.env` file based off `.env.sample` and then run `bundle exec ruby example.rb`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/controlshift/action-network-rest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/action_network_rest.gemspec

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "action_network_rest/version"
+require 'action_network_rest/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "action_network_rest"
+  spec.name          = 'action_network_rest'
   spec.version       = ActionNetworkRest::VERSION
-  spec.authors       = ["Grey Moore"]
-  spec.email         = ["grey@controlshiftlabs.com"]
+  spec.authors       = ['Grey Moore']
+  spec.email         = ['grey@controlshiftlabs.com']
 
-  spec.summary       = "Ruby client for interacting with the ActionNetwork REST API"
-  spec.homepage      = "https://github.com/controlshift/action-network-rest"
-  spec.license       = "MIT"
+  spec.summary       = 'Ruby client for interacting with the ActionNetwork REST API'
+  spec.homepage      = 'https://github.com/controlshift/action-network-rest'
+  spec.license       = 'MIT'
 
   # 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.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "vertebrae", "~> 0.6.0"
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_development_dependency "bundler", "~> 2.1"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'vertebrae', '~> 0.6.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'byebug', '~> 11.1'
+  spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'webmock', '~> 3.8.3'
 end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'action_network_rest'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/example.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'lib/action_network_rest'
+require 'dotenv'
+require 'byebug'
+
+Dotenv.load('.env')
+raise 'Must set API_KEY environmental variable. See .env.sample for details' if ENV['API_KEY'].nil?
+
+client = ActionNetworkRest.new(api_key: ENV['API_KEY']) # rubocop:disable Lint/UselessAssignment
+
+puts "Ready to call Action Network API using 'client' object"
+byebug # rubocop:disable Lint/Debugger
+
+puts 'Bye!'

data/lib/action_network_rest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vertebrae'
 
 module ActionNetworkRest
@@ -10,11 +12,16 @@ module ActionNetworkRest
   end
 end
 
-require "action_network_rest/version"
-require "action_network_rest/client"
+require 'action_network_rest/version'
+require 'action_network_rest/client'
 require 'action_network_rest/base'
 
+require 'action_network_rest/attendances'
 require 'action_network_rest/entry_point'
+require 'action_network_rest/events'
+require 'action_network_rest/event_campaigns'
 require 'action_network_rest/people'
 require 'action_network_rest/petitions'
 require 'action_network_rest/signatures'
+require 'action_network_rest/taggings'
+require 'action_network_rest/tags'

data/lib/action_network_rest/attendances.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Attendances < Base
+    attr_accessor :event_campaign_id, :event_id
+
+    def base_path
+      if event_campaign_id.present?
+        "event_campaigns/#{url_escape(event_campaign_id)}/events/#{url_escape(event_id)}/attendances/"
+      else
+        "events/#{url_escape(event_id)}/attendances/"
+      end
+    end
+
+    def create(attendance_data)
+      response = client.post_request base_path, attendance_data
+      object_from_response(response)
+    end
+
+    def update(id, attendance_data)
+      response = client.put_request "#{base_path}#{url_escape(id)}", attendance_data
+      object_from_response(response)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:attendance'
+    end
+  end
+end

data/lib/action_network_rest/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class Base < Vertebrae::Model
     def get(id)
@@ -5,25 +7,31 @@ module ActionNetworkRest
       object_from_response(response)
     end
 
+    def list(page: 1)
+      response = client.get_request "#{base_path}?page=#{url_escape(page)}"
+      objects = response.body.dig('_embedded', osdi_key)
+      return [] if objects.nil?
+
+      objects.each { |obj| set_action_network_id_on_object(obj) }
+
+      objects
+    end
+
     private
 
     def url_escape(string)
       CGI.escape(string.to_s)
     end
 
-    def object_from_response(response)
-      obj = response.body
-
-      # The response we get from Action Network may contain an "identifiers" block that looks something like:
-      #
+    def set_action_network_id_on_object(obj)
+      # 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.
       # "identifiers": [
       #   "action_network:d6bdf50e-c3a4-4981-a948-3d8c086066d7",
       #   "some_external_system:1",
       #   "another_external_system:57"
       # ]
-      #
-      # 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.
       identifiers = obj[:identifiers] || []
       qualified_actionnetwork_id = identifiers.find do |id|
         id.split(':').first == 'action_network'
@@ -35,6 +43,11 @@ module ActionNetworkRest
       obj
     end
 
+    def object_from_response(response)
+      obj = response.body
+      set_action_network_id_on_object(obj)
+    end
+
     def action_network_url(path)
       client.connection.configuration.endpoint + path
     end

data/lib/action_network_rest/client.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class Client < Vertebrae::API
     attr_accessor :api_key
 
-    def initialize(options={}, &block)
+    def initialize(options = {}, &block)
       self.api_key = options[:api_key]
-      super(options={}, &block)
+      super(options, &block)
     end
 
     def default_options
@@ -12,7 +14,7 @@ module ActionNetworkRest
         host: 'actionnetwork.org',
         prefix: '/api/v2',
         content_type: 'application/json',
-        additional_headers: {'OSDI-API-Token' => api_key},
+        additional_headers: { 'OSDI-API-Token' => api_key },
         user_agent: 'ruby: ActionNetworkRest'
       }
     end
@@ -23,6 +25,26 @@ module ActionNetworkRest
 
     ## Helpers to let users do things like `an_client.people.create(params)`
 
+    def events(event_id = nil)
+      if @_events&.send(:[], event_id).nil?
+        @_events = {} if @_events.nil?
+
+        @_events[event_id] = ActionNetworkRest::Events.new(event_id: event_id, client: self)
+      end
+
+      @_events[event_id]
+    end
+
+    def event_campaigns(event_campaign_id = nil)
+      if @_event_campaigns&.send(:[], event_campaign_id).nil?
+        @_event_campaigns = {} if @_event_campaigns.nil?
+
+        @_event_campaigns[event_campaign_id] = ActionNetworkRest::EventCampaigns.new(event_campaign_id, client: self)
+      end
+
+      @_event_campaigns[event_campaign_id]
+    end
+
     def entry_point
       @_entry_point ||= ActionNetworkRest::EntryPoint.new(client: self)
     end
@@ -31,8 +53,24 @@ module ActionNetworkRest
       @_people ||= ActionNetworkRest::People.new(client: self)
     end
 
-    def petitions(petition_id=nil)
-      @_petitions ||= ActionNetworkRest::Petitions.new(petition_id, client: self)
+    def petitions(petition_id = nil)
+      if @_petitions&.send(:[], petition_id).nil?
+        @_petitions = {} if @_petitions.nil?
+
+        @_petitions[petition_id] = ActionNetworkRest::Petitions.new(petition_id, client: self)
+      end
+
+      @_petitions[petition_id]
+    end
+
+    def tags(tag_id = nil)
+      if @_tags&.send(:[], tag_id).nil?
+        @_tags = {} if @_tags.nil?
+
+        @_tags[tag_id] = ActionNetworkRest::Tags.new(tag_id, client: self)
+      end
+
+      @_tags[tag_id]
     end
   end
 end

data/lib/action_network_rest/entry_point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class EntryPoint < Vertebrae::Model
     def base_path

data/lib/action_network_rest/event_campaigns.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class EventCampaigns < Base
+    attr_accessor :event_campaign_id
+
+    # Without a event_campaign_id, this class is used for EventCampaign creation/update endpoints.
+    # With a event_campaign_id, this class is used to initialise the Events class,
+    # like client.event_campaigns(123).events
+    def initialize(event_campaign_id = nil, client:)
+      super(client: client, event_campaign_id: event_campaign_id)
+    end
+
+    def base_path
+      'event_campaigns/'
+    end
+
+    def create(event_campaign_data)
+      response = client.post_request(base_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)
+    end
+
+    private
+
+    def osdi_key
+      'action_network:event_campaigns'
+    end
+  end
+end

data/lib/action_network_rest/events.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Events < Base
+    attr_accessor :event_campaign_id, :event_id
+
+    def initialize(client:, event_campaign_id: nil, event_id: nil)
+      super(client: client, event_id: event_id, event_campaign_id: event_campaign_id)
+    end
+
+    def base_path
+      if event_campaign_id.present?
+        "event_campaigns/#{url_escape(event_campaign_id)}/events/"
+      else
+        'events/'
+      end
+    end
+
+    def create(event_data)
+      response = client.post_request(base_path, event_data)
+      object_from_response(response)
+    end
+
+    def attendances
+      @_attendances ||= ActionNetworkRest::Attendances.new(client: client, event_id: event_id,
+                                                           event_campaign_id: event_campaign_id)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:events'
+    end
+  end
+end

data/lib/action_network_rest/people.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class People < Base
     def base_path
@@ -5,19 +7,48 @@ module ActionNetworkRest
     end
 
     def create(person_data, tags: [])
-      post_body = {'person' => person_data}
-      if tags.any?
-        post_body['add_tags'] = tags
-      end
+      post_body = { 'person' => person_data }
+      post_body['add_tags'] = tags if tags.any?
 
       response = client.post_request base_path, post_body
       object_from_response(response)
     end
 
     def unsubscribe(id)
-      request_body = {email_addresses: [{status: 'unsubscribed'}]}
+      request_body = { email_addresses: [{ status: 'unsubscribed' }] }
       response = client.put_request "#{base_path}#{url_escape(id)}", request_body
       object_from_response(response)
     end
+
+    def find_by_email(email)
+      # This works for parsing exactly 1 person's info out of the response.
+      # The response we get from Action Network is expected to have
+      #
+      # "_embedded": {
+      #   "osdi:people": [{
+      #       "identifiers": [
+      #           "action_network:c947bcd0-929e-11e3-a2e9-12313d316c29"
+      #            ....
+      #        ]
+      #    }]
+      # }
+      #
+      url_encoded_filter_string = url_escape("email_address eq '#{email}'")
+      response = client.get_request "#{base_path}?filter=#{url_encoded_filter_string}"
+      person_object = response.body[:_embedded][osdi_key].first
+      set_action_network_id_on_object(person_object) if person_object.present?
+    end
+
+    def update(id, person_data)
+      people_path = "#{base_path}#{url_escape(id)}"
+      response = client.put_request people_path, person_data
+      object_from_response(response)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:people'
+    end
   end
 end

data/lib/action_network_rest/petitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class Petitions < Base
     attr_accessor :petition_id
@@ -5,7 +7,7 @@ module ActionNetworkRest
     # Without a petition_id, this class is used for Petition creation/update endpoints.
     # With a petition_id, this class is used to initialise the Signatures class,
     # like client.petitions(123).signatures
-    def initialize(petition_id=nil, client:)
+    def initialize(petition_id = nil, client:)
       super(client: client, petition_id: petition_id)
     end
 
@@ -21,7 +23,7 @@ module ActionNetworkRest
       post_body = petition_data
       if creator_person_id.present?
         creator_person_url = action_network_url("/people/#{url_escape(creator_person_id)}")
-        post_body['_links'] = {'osdi:creator' => {href: creator_person_url}}
+        post_body['_links'] = { 'osdi:creator' => { href: creator_person_url } }
       end
 
       response = client.post_request base_path, post_body
@@ -33,5 +35,11 @@ module ActionNetworkRest
       response = client.put_request petition_path, petition_data
       object_from_response(response)
     end
+
+    private
+
+    def osdi_key
+      'osdi:petitions'
+    end
   end
 end

data/lib/action_network_rest/signatures.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
   class Signatures < Base
     attr_accessor :petition_id
@@ -6,24 +8,23 @@ module ActionNetworkRest
       "petitions/#{url_escape(petition_id)}/signatures/"
     end
 
-    def get(id)
-      response = client.get_request "#{base_path}#{url_escape(id)}"
-      object_from_response(response)
-    end
-
     def create(signature_data, tags: [])
       post_body = signature_data
-      if tags.any?
-        post_body['add_tags'] = tags
-      end
+      post_body['add_tags'] = tags if tags.any?
 
-      response = client.post_request base_path, post_body
+      response = client.post_request(base_path, post_body)
       object_from_response(response)
     end
 
     def update(id, signature_data)
-      response = client.put_request "#{base_path}#{url_escape(id)}", signature_data
+      response = client.put_request("#{base_path}#{url_escape(id)}", signature_data)
       object_from_response(response)
     end
+
+    private
+
+    def osdi_key
+      'osdi:signatures'
+    end
   end
 end

data/lib/action_network_rest/taggings.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Taggings < Base
+    attr_accessor :tag_id
+
+    def base_path
+      "tags/#{url_escape(tag_id)}/taggings/"
+    end
+
+    def create(tagging_data, person_id:)
+      post_body = tagging_data
+      person_url = action_network_url("/people/#{url_escape(person_id)}")
+      post_body['_links'] = { 'osdi:person' => { href: person_url } }
+
+      response = client.post_request base_path, post_body
+      object_from_response(response)
+    end
+
+    def delete(id)
+      response = client.delete_request "#{base_path}#{url_escape(id)}"
+      object_from_response(response)
+    end
+
+    private
+
+    def osdi_key
+      'osdi:taggings'
+    end
+  end
+end

data/lib/action_network_rest/tags.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ActionNetworkRest
+  class Tags < Base
+    attr_accessor :tag_id
+
+    # Without a tag_id, this class is used for the Tag creation endpoint.
+    # With a tag_id, this class is used to initialise the Taggings class,
+    # like client.tags(123).taggings
+    def initialize(tag_id = nil, client:)
+      super(client: client, tag_id: tag_id)
+    end
+
+    def taggings
+      @_taggings ||= ActionNetworkRest::Taggings.new(client: client, tag_id: tag_id)
+    end
+
+    def base_path
+      'tags/'
+    end
+
+    def create(name)
+      post_body = { name: name }
+      response = client.post_request base_path, post_body
+      object_from_response(response)
+    end
+
+    def find_by_name(name)
+      # Action Network API doesn't support currently OData querying for tags
+      # (https://actionnetwork.org/docs/v2#odata) so we need to retrieve a list of
+      # all tags and iterate to find the one we're looking for.
+      page = 1
+      loop do
+        tags = list(page: page)
+        return nil if tags.empty?
+
+        found_tag = tags.find { |t| t.name == name }
+        return found_tag unless found_tag.nil?
+
+        page += 1
+      end
+    end
+
+    private
+
+    def osdi_key
+      'osdi:tags'
+    end
+  end
+end

data/lib/action_network_rest/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionNetworkRest
-  VERSION = "0.2.0"
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Grey Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vertebrae
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -87,22 +143,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - action_network_rest.gemspec
+- bin/console
+- bin/rake
+- bin/rspec
+- example.rb
 - lib/action_network_rest.rb
+- lib/action_network_rest/attendances.rb
 - lib/action_network_rest/base.rb
 - lib/action_network_rest/client.rb
 - lib/action_network_rest/entry_point.rb
+- lib/action_network_rest/event_campaigns.rb
+- lib/action_network_rest/events.rb
 - lib/action_network_rest/people.rb
 - lib/action_network_rest/petitions.rb
 - lib/action_network_rest/signatures.rb
+- lib/action_network_rest/taggings.rb
+- lib/action_network_rest/tags.rb
 - lib/action_network_rest/version.rb
 homepage: https://github.com/controlshift/action-network-rest
 licenses:
@@ -116,14 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for interacting with the ActionNetwork REST API