action_network_rest 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +58 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/Rakefile +6 -0
- data/action_network_rest.gemspec +29 -0
- data/bin/console +14 -0
- data/bin/rake +29 -0
- data/bin/rspec +29 -0
- data/lib/action_network_rest.rb +22 -0
- data/lib/action_network_rest/base.rb +42 -0
- data/lib/action_network_rest/client.rb +54 -0
- data/lib/action_network_rest/entry_point.rb +21 -0
- data/lib/action_network_rest/people.rb +23 -0
- data/lib/action_network_rest/petitions.rb +37 -0
- data/lib/action_network_rest/signatures.rb +24 -0
- data/lib/action_network_rest/taggings.rb +23 -0
- data/lib/action_network_rest/tags.rb +26 -0
- data/lib/action_network_rest/version.rb +3 -0
- metadata +135 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 2c7052276bcde7acbbc808912711dd160a2ec75b13905dac5cd11d25555deadd
|
4
|
+
data.tar.gz: acc6e54314b4671d2969fb91065185f249c073d6371999648d0016bcef868383
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8065e41e4a565188ad1a2b6c24bb67c2858d4ea9d793b03082c4fd2cc0764ceba51f69df7481fa3e8ba6a961217cd3e769caa6c88fbcd90c286bbc9fdf5fef30
|
7
|
+
data.tar.gz: c4644fd81aba749b33a2871b4f776e182464c25f3be8f754d8d9209666aa98ea19ca1385d4fe977407a0e5e9ab0749224ee5211e2355891fba22d725e9635be2
|
data/.gitignore
ADDED
@@ -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
|
data/.ruby-gemset
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
action-network-rest
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.6.6
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -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
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.
|
data/README.md
ADDED
@@ -0,0 +1,101 @@
|
|
1
|
+
# ActionNetworkRest
|
2
|
+
|
3
|
+
Ruby client for interacting with the [ActionNetwork REST API](https://actionnetwork.org/docs/)
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'action_network_rest'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install action_network_rest
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```
|
24
|
+
client = ActionNetworkRest.new(api_key: YOUR_API_KEY)
|
25
|
+
|
26
|
+
# Check that our API key is working. Returns true or false.
|
27
|
+
client.entry_point.authenticated_successfully?
|
28
|
+
|
29
|
+
# See information about Action Network API endpoints
|
30
|
+
client.entry_point.get
|
31
|
+
|
32
|
+
# Create a new Person
|
33
|
+
person = client.people.create(email_addresses: [{address: 'foo@example.com'}])
|
34
|
+
person_id = person.action_network_id
|
35
|
+
|
36
|
+
# Retrieve a Person's data
|
37
|
+
person = client.people.get(person_id)
|
38
|
+
puts person.email_addresses
|
39
|
+
|
40
|
+
# Unsubscribe a Person
|
41
|
+
client.people.unsubscribe(person_id)
|
42
|
+
|
43
|
+
# Create a new Petition
|
44
|
+
petition = client.petitions.create({title: 'Do the Thing!'}, creator_person_id: person_id)
|
45
|
+
petition_id = petition.action_network_id
|
46
|
+
|
47
|
+
# Retrieve a Petition
|
48
|
+
petition = client.petitions.get(petition_id)
|
49
|
+
puts petition.title
|
50
|
+
|
51
|
+
# Update a Petition
|
52
|
+
client.petitions.update(petition_id, {description: 'An updated description'})
|
53
|
+
|
54
|
+
# Create a Signature on a Petition
|
55
|
+
signature = client.petitions(petition_id).signatures.create({comments: 'This is so important',
|
56
|
+
person: {email_addresses: [{address: 'alice@example.com'}]}},
|
57
|
+
tags: ['volunteer'])
|
58
|
+
signature_id = signature.action_network_id
|
59
|
+
|
60
|
+
# Retrieve a Signature
|
61
|
+
signature = client.petitions(petition_id).signatures.get(signature_id)
|
62
|
+
puts signature.created_date
|
63
|
+
|
64
|
+
# Update a Signature
|
65
|
+
client.petitions(petition_id).signatures.update(signature_id, {comments: 'new comments'})
|
66
|
+
|
67
|
+
# Create a Tag
|
68
|
+
tag = client.tags.create('Volunteers')
|
69
|
+
tag_id = tag.action_network_id
|
70
|
+
|
71
|
+
# Retrieve a Tag
|
72
|
+
tag = client.tags.get(tag_id)
|
73
|
+
|
74
|
+
# Apply a Tag to a Person
|
75
|
+
tagging = client.tags(tag_id).create({identifiers: ['external:123']}, person_id: person_id)
|
76
|
+
tagging_id = tagging.action_network_id
|
77
|
+
|
78
|
+
# Retrieve a Tagging
|
79
|
+
tagging = client.tags(tag_id).taggings.get(tagging_id)
|
80
|
+
|
81
|
+
# Delete a Tagging
|
82
|
+
client.tags(tag_id).taggings.delete(tagging_id)
|
83
|
+
```
|
84
|
+
|
85
|
+
## Development
|
86
|
+
|
87
|
+
After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
|
88
|
+
|
89
|
+
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).
|
90
|
+
|
91
|
+
## Contributing
|
92
|
+
|
93
|
+
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.
|
94
|
+
|
95
|
+
## License
|
96
|
+
|
97
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
98
|
+
|
99
|
+
## Code of Conduct
|
100
|
+
|
101
|
+
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).
|
data/Rakefile
ADDED
@@ -0,0 +1,29 @@
|
|
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 "rake", "~> 13.0"
|
27
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
28
|
+
spec.add_development_dependency 'webmock', '~> 3.8.3'
|
29
|
+
end
|
data/bin/console
ADDED
@@ -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__)
|
data/bin/rake
ADDED
@@ -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")
|
data/bin/rspec
ADDED
@@ -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,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,42 @@
|
|
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
|
+
private
|
9
|
+
|
10
|
+
def url_escape(string)
|
11
|
+
CGI.escape(string.to_s)
|
12
|
+
end
|
13
|
+
|
14
|
+
def object_from_response(response)
|
15
|
+
obj = response.body
|
16
|
+
|
17
|
+
# The response we get from Action Network may contain an "identifiers" block that looks something like:
|
18
|
+
#
|
19
|
+
# "identifiers": [
|
20
|
+
# "action_network:d6bdf50e-c3a4-4981-a948-3d8c086066d7",
|
21
|
+
# "some_external_system:1",
|
22
|
+
# "another_external_system:57"
|
23
|
+
# ]
|
24
|
+
#
|
25
|
+
# If so, we pull out the action_network identifier and stick it in a top-level key "action_network_id",
|
26
|
+
# for the convenience of callers using the returned object.
|
27
|
+
identifiers = obj[:identifiers] || []
|
28
|
+
qualified_actionnetwork_id = identifiers.find do |id|
|
29
|
+
id.split(':').first == 'action_network'
|
30
|
+
end
|
31
|
+
if qualified_actionnetwork_id.present?
|
32
|
+
obj.action_network_id = qualified_actionnetwork_id.sub(/^action_network:/, '')
|
33
|
+
end
|
34
|
+
|
35
|
+
obj
|
36
|
+
end
|
37
|
+
|
38
|
+
def action_network_url(path)
|
39
|
+
client.connection.configuration.endpoint + path
|
40
|
+
end
|
41
|
+
end
|
42
|
+
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,23 @@
|
|
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
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,37 @@
|
|
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
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,24 @@
|
|
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
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,23 @@
|
|
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
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,26 @@
|
|
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
|
+
end
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,135 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: action_network_rest
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.3.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Grey Moore
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-04-29 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: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '13.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '13.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: webmock
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 3.8.3
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: 3.8.3
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- grey@controlshiftlabs.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- ".ruby-gemset"
|
92
|
+
- ".ruby-version"
|
93
|
+
- CODE_OF_CONDUCT.md
|
94
|
+
- Gemfile
|
95
|
+
- LICENSE
|
96
|
+
- README.md
|
97
|
+
- Rakefile
|
98
|
+
- action_network_rest.gemspec
|
99
|
+
- bin/console
|
100
|
+
- bin/rake
|
101
|
+
- bin/rspec
|
102
|
+
- lib/action_network_rest.rb
|
103
|
+
- lib/action_network_rest/base.rb
|
104
|
+
- lib/action_network_rest/client.rb
|
105
|
+
- lib/action_network_rest/entry_point.rb
|
106
|
+
- lib/action_network_rest/people.rb
|
107
|
+
- lib/action_network_rest/petitions.rb
|
108
|
+
- lib/action_network_rest/signatures.rb
|
109
|
+
- lib/action_network_rest/taggings.rb
|
110
|
+
- lib/action_network_rest/tags.rb
|
111
|
+
- lib/action_network_rest/version.rb
|
112
|
+
homepage: https://github.com/controlshift/action-network-rest
|
113
|
+
licenses:
|
114
|
+
- MIT
|
115
|
+
metadata: {}
|
116
|
+
post_install_message:
|
117
|
+
rdoc_options: []
|
118
|
+
require_paths:
|
119
|
+
- lib
|
120
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - ">="
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
requirements: []
|
131
|
+
rubygems_version: 3.1.2
|
132
|
+
signing_key:
|
133
|
+
specification_version: 4
|
134
|
+
summary: Ruby client for interacting with the ActionNetwork REST API
|
135
|
+
test_files: []
|