action_network_rest 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: abb5c663b923a0f30bfcaf0b70fd43de40baf9f59752154eaead286acf7259a7
4
+ data.tar.gz: dbd808c9166b1047c70d87df247a5d624851f1e69a4271da6edb70ca578a9161
5
+ SHA512:
6
+ metadata.gz: 71b0865b95a6d0ac618f6d9a35379b9998391c05dee7714c5b12dc0c8215e2ade7163cd8d2e81b3bd1a5d4743d6599207c22d48b22a7a5f9e724ccbc99ebe907
7
+ data.tar.gz: afac667e373e1ce51641edd1cde82d4269220ef95b847cc589fd9ffa079419e559f42c677210a87a91888e978a40ac07c5199179e684923f2feebc8c032849a8
@@ -0,0 +1,2 @@
1
+ # API key used on example.rb, you don't need to define this in the gem including code
2
+ API_KEY=xyz
@@ -0,0 +1,58 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /spec/examples.txt
9
+ /test/tmp/
10
+ /test/version_tmp/
11
+ /tmp/
12
+
13
+ # Used by dotenv library to load environment variables.
14
+ .env
15
+
16
+ # Ignore Byebug command history file.
17
+ .byebug_history
18
+
19
+ ## Specific to RubyMotion:
20
+ .dat*
21
+ .repl_history
22
+ build/
23
+ *.bridgesupport
24
+ build-iPhoneOS/
25
+ build-iPhoneSimulator/
26
+
27
+ ## Specific to RubyMotion (use of CocoaPods):
28
+ #
29
+ # We recommend against adding the Pods directory to your .gitignore. However
30
+ # you should judge for yourself, the pros and cons are mentioned at:
31
+ # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
32
+ #
33
+ # vendor/Pods/
34
+
35
+ ## Documentation cache and generated files:
36
+ /.yardoc/
37
+ /_yardoc/
38
+ /doc/
39
+ /rdoc/
40
+
41
+ ## Environment normalization:
42
+ /.bundle/
43
+ /vendor/bundle
44
+ /lib/bundler/man/
45
+
46
+ # for a library or gem, you might want to ignore these files since the code is
47
+ # intended to run in multiple environments; otherwise, check them in:
48
+ Gemfile.lock
49
+ # .ruby-version
50
+ # .ruby-gemset
51
+
52
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
53
+ .rvmrc
54
+
55
+ # Used by RuboCop. Remote config files pulled in from inherit_from directive.
56
+ # .rubocop-https?--*
57
+
58
+ .rspec_status
@@ -0,0 +1,26 @@
1
+ AllCops:
2
+ DisabledByDefault: true
3
+
4
+ Security:
5
+ Enabled: true
6
+
7
+ Bundler/DuplicatedGem:
8
+ Enabled: true
9
+ Bundler/InsecureProtocolSource:
10
+ Enabled: true
11
+ Layout/IndentationStyle:
12
+ Enabled: true
13
+ Layout/SpaceInsideRangeLiteral:
14
+ Enabled: true
15
+ Lint:
16
+ Enabled: true
17
+ Lint/RaiseException:
18
+ Enabled: true
19
+ Naming/AsciiIdentifiers:
20
+ Enabled: true
21
+ Naming/ClassAndModuleCamelCase:
22
+ Enabled: true
23
+ Naming/ConstantName:
24
+ Enabled: true
25
+ Naming/FileName:
26
+ Enabled: true
@@ -0,0 +1 @@
1
+ action-network-rest
@@ -0,0 +1 @@
1
+ 2.6.6
@@ -0,0 +1,9 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.6
4
+ cache: bundler
5
+ before_install:
6
+ - gem install bundler
7
+ script:
8
+ - bundle exec rspec
9
+ - bundle exec rubocop
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at talk@controlshiftlabs.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in action_network_rest.gemspec
6
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 ControlShift
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,124 @@
1
+ # ActionNetworkRest
2
+
3
+ Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/) from the engineering team at [ControlShift](https://www.controlshiftlabs.com/).
4
+
5
+ [![Build Status](https://travis-ci.org/controlshift/action-network-rest.svg?branch=master)](https://travis-ci.org/controlshift/action-network-rest)
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'action_network_rest'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install action_network_rest
22
+
23
+ ## Usage
24
+
25
+ ```
26
+ client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
27
+
28
+ # Check that our API key is working. Returns true or false.
29
+ client.entry_point.authenticated_successfully?
30
+
31
+ # See information about Action Network API endpoints
32
+ client.entry_point.get
33
+
34
+ # Create a new Person
35
+ person = client.people.create(email_addresses: [{address: 'foo@example.com'}])
36
+ person_id = person.action_network_id
37
+
38
+ # List people
39
+ people = client.people.list
40
+
41
+ # Iterate over a list of people
42
+ page_number = 1
43
+ loop do
44
+ people = client.people.list(page: page_number)
45
+ break if people.empty?
46
+ page_number += 1
47
+ end
48
+
49
+ # Retrieve a Person's data
50
+ person = client.people.get(person_id)
51
+ puts person.email_addresses
52
+
53
+ # Retrieve a Person's data by their email address
54
+ person = client.people.find_by_email(person_email
55
+ person_id = person.action_network_id
56
+ puts person.email_addresses
57
+
58
+ # Unsubscribe a Person
59
+ client.people.unsubscribe(person_id)
60
+
61
+ # Create a new Petition
62
+ petition = client.petitions.create({title: 'Do the Thing!'}, creator_person_id: person_id)
63
+ petition_id = petition.action_network_id
64
+
65
+ # Retrieve a Petition
66
+ petition = client.petitions.get(petition_id)
67
+ puts petition.title
68
+
69
+ # Update a Petition
70
+ client.petitions.update(petition_id, {description: 'An updated description'})
71
+
72
+ # Create a Signature on a Petition
73
+ signature = client.petitions(petition_id).signatures.create({comments: 'This is so important',
74
+ person: {email_addresses: [{address: 'alice@example.com'}]}},
75
+ tags: ['volunteer'])
76
+ signature_id = signature.action_network_id
77
+
78
+ # Retrieve a Signature
79
+ signature = client.petitions(petition_id).signatures.get(signature_id)
80
+ puts signature.created_date
81
+
82
+ # Update a Signature
83
+ client.petitions(petition_id).signatures.update(signature_id, {comments: 'new comments'})
84
+
85
+ # Create a Tag
86
+ tag = client.tags.create('Volunteers')
87
+ tag_id = tag.action_network_id
88
+
89
+ # Retrieve a Tag
90
+ tag = client.tags.get(tag_id)
91
+
92
+ # Retrieve a Tag by name
93
+ tag = client.tags.find_by_name('Volunteers')
94
+
95
+ # Apply a Tag to a Person
96
+ tagging = client.tags(tag_id).create({identifiers: ['external:123']}, person_id: person_id)
97
+ tagging_id = tagging.action_network_id
98
+
99
+ # Retrieve a Tagging
100
+ tagging = client.tags(tag_id).taggings.get(tagging_id)
101
+
102
+ # Delete a Tagging
103
+ client.tags(tag_id).taggings.delete(tagging_id)
104
+ ```
105
+
106
+ ## Development
107
+
108
+ After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
109
+
110
+ 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).
111
+
112
+ 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`.
113
+
114
+ ## Contributing
115
+
116
+ 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.
117
+
118
+ ## License
119
+
120
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
121
+
122
+ ## Code of Conduct
123
+
124
+ Everyone interacting in the ActionNetworkRest project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/controlshift/action-network-rest/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,32 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "action_network_rest/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "action_network_rest"
8
+ spec.version = ActionNetworkRest::VERSION
9
+ spec.authors = ["Grey Moore"]
10
+ spec.email = ["grey@controlshiftlabs.com"]
11
+
12
+ spec.summary = "Ruby client for interacting with the ActionNetwork REST API"
13
+ spec.homepage = "https://github.com/controlshift/action-network-rest"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_runtime_dependency "vertebrae", "~> 0.6.0"
24
+
25
+ spec.add_development_dependency "bundler", "~> 2.1"
26
+ spec.add_development_dependency "byebug", "~> 11.1"
27
+ spec.add_development_dependency "dotenv", "~> 2.7"
28
+ spec.add_development_dependency "rake", "~> 13.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ spec.add_development_dependency 'webmock', '~> 3.8.3'
31
+ spec.add_development_dependency 'rubocop'
32
+ end
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "action_network_rest"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'rake' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ require "pathname"
12
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13
+ Pathname.new(__FILE__).realpath)
14
+
15
+ bundle_binstub = File.expand_path("../bundle", __FILE__)
16
+
17
+ if File.file?(bundle_binstub)
18
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
19
+ load(bundle_binstub)
20
+ else
21
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
23
+ end
24
+ end
25
+
26
+ require "rubygems"
27
+ require "bundler/setup"
28
+
29
+ load Gem.bin_path("rake", "rake")
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'rspec' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ require "pathname"
12
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
13
+ Pathname.new(__FILE__).realpath)
14
+
15
+ bundle_binstub = File.expand_path("../bundle", __FILE__)
16
+
17
+ if File.file?(bundle_binstub)
18
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
19
+ load(bundle_binstub)
20
+ else
21
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
22
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
23
+ end
24
+ end
25
+
26
+ require "rubygems"
27
+ require "bundler/setup"
28
+
29
+ load Gem.bin_path("rspec-core", "rspec")
@@ -0,0 +1,13 @@
1
+ require_relative 'lib/action_network_rest'
2
+ require 'dotenv'
3
+ require 'byebug'
4
+
5
+ Dotenv.load('.env')
6
+ raise 'Must set API_KEY environmental variable. See .env.sample for details' if ENV['API_KEY'].nil?
7
+
8
+ client = ActionNetworkRest.new(api_key: ENV['API_KEY']) # rubocop:disable Lint/UselessAssignment
9
+
10
+ puts "Ready to call Action Network API using 'client' object"
11
+ byebug # rubocop:disable Lint/Debugger
12
+
13
+ puts "Bye!"
@@ -0,0 +1,22 @@
1
+ require 'vertebrae'
2
+
3
+ module ActionNetworkRest
4
+ extend Vertebrae::Base
5
+
6
+ class << self
7
+ def new(options = {})
8
+ ActionNetworkRest::Client.new(options)
9
+ end
10
+ end
11
+ end
12
+
13
+ require "action_network_rest/version"
14
+ require "action_network_rest/client"
15
+ require 'action_network_rest/base'
16
+
17
+ require 'action_network_rest/entry_point'
18
+ require 'action_network_rest/people'
19
+ require 'action_network_rest/petitions'
20
+ require 'action_network_rest/signatures'
21
+ require 'action_network_rest/taggings'
22
+ require 'action_network_rest/tags'
@@ -0,0 +1,53 @@
1
+ module ActionNetworkRest
2
+ class Base < Vertebrae::Model
3
+ def get(id)
4
+ response = client.get_request "#{base_path}#{url_escape(id)}"
5
+ object_from_response(response)
6
+ end
7
+
8
+ def list(page: 1)
9
+ response = client.get_request "#{base_path}?page=#{page}"
10
+ objects = response.body.dig('_embedded', osdi_key)
11
+ return [] if objects.nil?
12
+
13
+ objects.each { |obj| set_action_network_id_on_object(obj) }
14
+
15
+ objects
16
+ end
17
+
18
+ private
19
+
20
+ def url_escape(string)
21
+ CGI.escape(string.to_s)
22
+ end
23
+
24
+ def set_action_network_id_on_object(obj)
25
+ # Takes an object which may contain an `identifiers` key, which may contain an action_network identifier
26
+ # If so, we pull out the action_network identifier and stick it in a top-level key "action_network_id",
27
+ # for the convenience of callers using the returned object.
28
+ # "identifiers": [
29
+ # "action_network:d6bdf50e-c3a4-4981-a948-3d8c086066d7",
30
+ # "some_external_system:1",
31
+ # "another_external_system:57"
32
+ # ]
33
+ identifiers = obj[:identifiers] || []
34
+ qualified_actionnetwork_id = identifiers.find do |id|
35
+ id.split(':').first == 'action_network'
36
+ end
37
+ if qualified_actionnetwork_id.present?
38
+ obj.action_network_id = qualified_actionnetwork_id.sub(/^action_network:/, '')
39
+ end
40
+
41
+ obj
42
+ end
43
+
44
+ def object_from_response(response)
45
+ obj = response.body
46
+ set_action_network_id_on_object(obj)
47
+ end
48
+
49
+ def action_network_url(path)
50
+ client.connection.configuration.endpoint + path
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,54 @@
1
+ module ActionNetworkRest
2
+ class Client < Vertebrae::API
3
+ attr_accessor :api_key
4
+
5
+ def initialize(options={}, &block)
6
+ self.api_key = options[:api_key]
7
+ super(options, &block)
8
+ end
9
+
10
+ def default_options
11
+ {
12
+ host: 'actionnetwork.org',
13
+ prefix: '/api/v2',
14
+ content_type: 'application/json',
15
+ additional_headers: {'OSDI-API-Token' => api_key},
16
+ user_agent: 'ruby: ActionNetworkRest'
17
+ }
18
+ end
19
+
20
+ def extract_data_from_params(params)
21
+ params.to_json
22
+ end
23
+
24
+ ## Helpers to let users do things like `an_client.people.create(params)`
25
+
26
+ def entry_point
27
+ @_entry_point ||= ActionNetworkRest::EntryPoint.new(client: self)
28
+ end
29
+
30
+ def people
31
+ @_people ||= ActionNetworkRest::People.new(client: self)
32
+ end
33
+
34
+ def petitions(petition_id=nil)
35
+ if @_petitions&.send(:[], petition_id).nil?
36
+ @_petitions = {} if @_petitions.nil?
37
+
38
+ @_petitions[petition_id] = ActionNetworkRest::Petitions.new(petition_id, client: self)
39
+ end
40
+
41
+ @_petitions[petition_id]
42
+ end
43
+
44
+ def tags(tag_id=nil)
45
+ if @_tags&.send(:[], tag_id).nil?
46
+ @_tags = {} if @_tags.nil?
47
+
48
+ @_tags[tag_id] = ActionNetworkRest::Tags.new(tag_id, client: self)
49
+ end
50
+
51
+ @_tags[tag_id]
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,21 @@
1
+ module ActionNetworkRest
2
+ class EntryPoint < Vertebrae::Model
3
+ def base_path
4
+ ''
5
+ end
6
+
7
+ def get
8
+ response = client.get_request base_path
9
+ response.body
10
+ end
11
+
12
+ def authenticated_successfully?
13
+ response_body = get
14
+
15
+ # If we successfully authenticated, the entrypoint response will include a reference to tags.
16
+ # If not (API key missing or wrong), the response will not include anything about tags,
17
+ # but will otherwise be successful.
18
+ response_body.dig('_links', 'osdi:tags').present?
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,50 @@
1
+ module ActionNetworkRest
2
+ class People < Base
3
+ def base_path
4
+ 'people/'
5
+ end
6
+
7
+ def create(person_data, tags: [])
8
+ post_body = {'person' => person_data}
9
+ if tags.any?
10
+ post_body['add_tags'] = tags
11
+ end
12
+
13
+ response = client.post_request base_path, post_body
14
+ object_from_response(response)
15
+ end
16
+
17
+ def unsubscribe(id)
18
+ request_body = {email_addresses: [{status: 'unsubscribed'}]}
19
+ response = client.put_request "#{base_path}#{url_escape(id)}", request_body
20
+ object_from_response(response)
21
+ end
22
+
23
+ def find_by_email(email)
24
+ # This works for parsing exactly 1 person's info out of the response.
25
+ # The response we get from Action Network is expected to have
26
+ #
27
+ # "_embedded": {
28
+ # "osdi:people": [{
29
+ # "identifiers": [
30
+ # "action_network:c947bcd0-929e-11e3-a2e9-12313d316c29"
31
+ # ....
32
+ # ]
33
+ # }]
34
+ # }
35
+ #
36
+ url_encoded_filter_string = url_escape("email_address eq '#{email}'")
37
+ response = client.get_request "#{base_path}?filter=#{url_encoded_filter_string}"
38
+ person_object = response.body[:_embedded][osdi_key].first
39
+ if person_object.present?
40
+ set_action_network_id_on_object(person_object)
41
+ end
42
+ end
43
+
44
+ private
45
+
46
+ def osdi_key
47
+ 'osdi:people'
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,43 @@
1
+ module ActionNetworkRest
2
+ class Petitions < Base
3
+ attr_accessor :petition_id
4
+
5
+ # Without a petition_id, this class is used for Petition creation/update endpoints.
6
+ # With a petition_id, this class is used to initialise the Signatures class,
7
+ # like client.petitions(123).signatures
8
+ def initialize(petition_id=nil, client:)
9
+ super(client: client, petition_id: petition_id)
10
+ end
11
+
12
+ def signatures
13
+ @_signatures ||= ActionNetworkRest::Signatures.new(client: client, petition_id: petition_id)
14
+ end
15
+
16
+ def base_path
17
+ 'petitions/'
18
+ end
19
+
20
+ def create(petition_data, creator_person_id: nil)
21
+ post_body = petition_data
22
+ if creator_person_id.present?
23
+ creator_person_url = action_network_url("/people/#{url_escape(creator_person_id)}")
24
+ post_body['_links'] = {'osdi:creator' => {href: creator_person_url}}
25
+ end
26
+
27
+ response = client.post_request base_path, post_body
28
+ object_from_response(response)
29
+ end
30
+
31
+ def update(id, petition_data)
32
+ petition_path = "#{base_path}#{url_escape(id)}"
33
+ response = client.put_request petition_path, petition_data
34
+ object_from_response(response)
35
+ end
36
+
37
+ private
38
+
39
+ def osdi_key
40
+ 'osdi:petitions'
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,30 @@
1
+ module ActionNetworkRest
2
+ class Signatures < Base
3
+ attr_accessor :petition_id
4
+
5
+ def base_path
6
+ "petitions/#{url_escape(petition_id)}/signatures/"
7
+ end
8
+
9
+ def create(signature_data, tags: [])
10
+ post_body = signature_data
11
+ if tags.any?
12
+ post_body['add_tags'] = tags
13
+ end
14
+
15
+ response = client.post_request base_path, post_body
16
+ object_from_response(response)
17
+ end
18
+
19
+ def update(id, signature_data)
20
+ response = client.put_request "#{base_path}#{url_escape(id)}", signature_data
21
+ object_from_response(response)
22
+ end
23
+
24
+ private
25
+
26
+ def osdi_key
27
+ 'osdi:signatures'
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,29 @@
1
+ module ActionNetworkRest
2
+ class Taggings < Base
3
+ attr_accessor :tag_id
4
+
5
+ def base_path
6
+ "tags/#{url_escape(tag_id)}/taggings/"
7
+ end
8
+
9
+ def create(tagging_data, person_id:)
10
+ post_body = tagging_data
11
+ person_url = action_network_url("/people/#{url_escape(person_id)}")
12
+ post_body['_links'] = {'osdi:person' => {href: person_url}}
13
+
14
+ response = client.post_request base_path, post_body
15
+ object_from_response(response)
16
+ end
17
+
18
+ def delete(id)
19
+ response = client.delete_request "#{base_path}#{url_escape(id)}"
20
+ object_from_response(response)
21
+ end
22
+
23
+ private
24
+
25
+ def osdi_key
26
+ 'osdi:taggings'
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,48 @@
1
+ module ActionNetworkRest
2
+ class Tags < Base
3
+ attr_accessor :tag_id
4
+
5
+ # Without a tag_id, this class is used for the Tag creation endpoint.
6
+ # With a tag_id, this class is used to initialise the Taggings class,
7
+ # like client.tags(123).taggings
8
+ def initialize(tag_id=nil, client:)
9
+ super(client: client, tag_id: tag_id)
10
+ end
11
+
12
+ def taggings
13
+ @_taggings ||= ActionNetworkRest::Taggings.new(client: client, tag_id: tag_id)
14
+ end
15
+
16
+ def base_path
17
+ 'tags/'
18
+ end
19
+
20
+ def create(name)
21
+ post_body = {name: name}
22
+ response = client.post_request base_path, post_body
23
+ object_from_response(response)
24
+ end
25
+
26
+ def find_by_name(name)
27
+ # Action Network API doesn't support currently OData querying for tags
28
+ # (https://actionnetwork.org/docs/v2#odata) so we need to retrieve a list of
29
+ # all tags and iterate to find the one we're looking for.
30
+ page = 1
31
+ loop do
32
+ tags = self.list(page: page)
33
+ return nil if tags.empty?
34
+
35
+ found_tag = tags.find { |t| t.name == name }
36
+ return found_tag unless found_tag.nil?
37
+
38
+ page += 1
39
+ end
40
+ end
41
+
42
+ private
43
+
44
+ def osdi_key
45
+ 'osdi:tags'
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,3 @@
1
+ module ActionNetworkRest
2
+ VERSION = "0.5.0"
3
+ end
metadata ADDED
@@ -0,0 +1,181 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: action_network_rest
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.5.0
5
+ platform: ruby
6
+ authors:
7
+ - Grey Moore
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2020-05-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: vertebrae
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.6.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.6.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.1'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.1'
41
+ - !ruby/object:Gem::Dependency
42
+ name: byebug
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '11.1'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '11.1'
55
+ - !ruby/object:Gem::Dependency
56
+ name: dotenv
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '2.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '2.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '13.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '13.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: webmock
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 3.8.3
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 3.8.3
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description:
126
+ email:
127
+ - grey@controlshiftlabs.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".env.sample"
133
+ - ".gitignore"
134
+ - ".rubocop.yml"
135
+ - ".ruby-gemset"
136
+ - ".ruby-version"
137
+ - ".travis.yml"
138
+ - CODE_OF_CONDUCT.md
139
+ - Gemfile
140
+ - LICENSE
141
+ - README.md
142
+ - Rakefile
143
+ - action_network_rest.gemspec
144
+ - bin/console
145
+ - bin/rake
146
+ - bin/rspec
147
+ - example.rb
148
+ - lib/action_network_rest.rb
149
+ - lib/action_network_rest/base.rb
150
+ - lib/action_network_rest/client.rb
151
+ - lib/action_network_rest/entry_point.rb
152
+ - lib/action_network_rest/people.rb
153
+ - lib/action_network_rest/petitions.rb
154
+ - lib/action_network_rest/signatures.rb
155
+ - lib/action_network_rest/taggings.rb
156
+ - lib/action_network_rest/tags.rb
157
+ - lib/action_network_rest/version.rb
158
+ homepage: https://github.com/controlshift/action-network-rest
159
+ licenses:
160
+ - MIT
161
+ metadata: {}
162
+ post_install_message:
163
+ rdoc_options: []
164
+ require_paths:
165
+ - lib
166
+ required_ruby_version: !ruby/object:Gem::Requirement
167
+ requirements:
168
+ - - ">="
169
+ - !ruby/object:Gem::Version
170
+ version: '0'
171
+ required_rubygems_version: !ruby/object:Gem::Requirement
172
+ requirements:
173
+ - - ">="
174
+ - !ruby/object:Gem::Version
175
+ version: '0'
176
+ requirements: []
177
+ rubygems_version: 3.0.8
178
+ signing_key:
179
+ specification_version: 4
180
+ summary: Ruby client for interacting with the ActionNetwork REST API
181
+ test_files: []