action_network_rest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc85d83854d521199b82e855ee4369c66c076a8487753756cc454010a0a22907
-  data.tar.gz: 684db90a396a39ebbdc54ffec3fcdba678a2338fbc334052786f7422d4990eb9
+  metadata.gz: 2c7052276bcde7acbbc808912711dd160a2ec75b13905dac5cd11d25555deadd
+  data.tar.gz: acc6e54314b4671d2969fb91065185f249c073d6371999648d0016bcef868383
 SHA512:
-  metadata.gz: fa5f2ece5e76ef8bfbffd96349eb0c545c423da441a318fab71458d86f7ebfd483a4bc7f512f25df73ad9a5f1acfc32a1f60e1acb69770f5b0c75b8b695420ec
-  data.tar.gz: '0897288683f87fc8a9a273d360bf01bbbcf0da24bf7d90ffbb1176299a79f376a01d55e57af7a7680a771c8787579f78353eb5d32a08b0691d131b76f4431b45'
+  metadata.gz: 8065e41e4a565188ad1a2b6c24bb67c2858d4ea9d793b03082c4fd2cc0764ceba51f69df7481fa3e8ba6a961217cd3e769caa6c88fbcd90c286bbc9fdf5fef30
+  data.tar.gz: c4644fd81aba749b33a2871b4f776e182464c25f3be8f754d8d9209666aa98ea19ca1385d4fe977407a0e5e9ab0749224ee5211e2355891fba22d725e9635be2

data/README.md

@@ -63,6 +63,23 @@ 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)
+
+# 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)
 ```
 
 ## Development

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    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", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    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/lib/action_network_rest.rb

@@ -18,3 +18,5 @@ require 'action_network_rest/entry_point'
 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/client.rb

@@ -32,7 +32,23 @@ module ActionNetworkRest
     end
 
     def petitions(petition_id=nil)
-      @_petitions ||= ActionNetworkRest::Petitions.new(petition_id, client: self)
+      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/signatures.rb

@@ -6,11 +6,6 @@ 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?

data/lib/action_network_rest/taggings.rb

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

data/lib/action_network_rest/tags.rb

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

data/lib/action_network_rest/version.rb

@@ -1,3 +1,3 @@
 module ActionNetworkRest
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_network_rest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Grey Moore
@@ -96,6 +96,9 @@ files:
 - README.md
 - Rakefile
 - action_network_rest.gemspec
+- bin/console
+- bin/rake
+- bin/rspec
 - lib/action_network_rest.rb
 - lib/action_network_rest/base.rb
 - lib/action_network_rest/client.rb
@@ -103,6 +106,8 @@ files:
 - 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: