mobilize-america-client 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b117cee8af822cab72b97313c0ed7308cc36172dfd12ddab7780e24a3162475e
+  data.tar.gz: 8c3f8ac61a4e80d89caa744dd3429bbb08a681a0e9fb213d5bb518ed5d173ed3
+SHA512:
+  metadata.gz: e031b5195b8571b03b975df4e55a591c781e909c21f799f2b427044155743e5a125b5fa6fdbec6b31ac060471a0c6f1939464eabcff4bb9a2f7a9b77a328fb6a
+  data.tar.gz: 337c481793e7e8f57116af8176dfdffe4f1bf6c2343a452e460a6731934eb8ac069fb3b11b3105d94346cd3a30634d578bc206d21af020123ea4e027af42dd6c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jacinda@controlshiftlabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem 'faraday', '~> 0.15'
+
+group :development do
+  gem 'rspec', '~> 3.0'
+  gem 'juwelier', '~> 2.4'
+  gem 'rake', '~> 10.0'
+  gem 'webmock', '~> 3.4'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 ControlShift
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jacinda Moore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# MobilizeAmericaClient::Client
+
+A minimalist API client for the [MobilizeAmerica API](https://github.com/mobilizeamerica/api):
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mobilize-america-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mobilize-america-client
+
+## Usage
+
+For now, the gem only supports listing an organization's events.
+
+`MobilizeAmericaClient.new.organization_events(organization_id: 123)`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/controlshift/mobilize-america-client. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MobilizeAmericaClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/controlshift/mobilize-america-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "mobilize-america-client"
+  gem.homepage = "http://github.com/controlshift/mobilize_america_client"
+  gem.license = "MIT"
+  gem.summary = %Q{Client gem for the MobilizeAmerica API}
+  gem.email = "jacinda@controlshiftlabs.com"
+  gem.authors = ["Jacinda Moore"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mobilize-america-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mobilizeamerica/client"
+
+# 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/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mobilize_america_client.rb

@@ -0,0 +1,9 @@
+require 'mobilize_america_client/client'
+
+module MobilizeAmerica
+  class << self
+    def new
+      MobilizeAmericaClient::Client.new
+    end
+  end
+end

data/lib/mobilize_america_client/client.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+require 'mobilize_america_client/client/events'
+require 'mobilize_america_client/request'
+
+module MobilizeAmericaClient
+  class Client
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(url: "https://#{API_DOMAIN}")
+    end
+
+    include MobilizeAmericaClient::Request
+    include MobilizeAmericaClient::Client::Events
+  end
+end

data/lib/mobilize_america_client/client/events.rb

@@ -0,0 +1,32 @@
+module MobilizeAmericaClient
+  class Client
+    module Events
+      def organization_events(organization_id:, updated_since: nil, max_distance_miles: nil, page: nil, per_page: nil,
+                              zipcode: nil)
+        params = {}
+
+        unless page.nil?
+          params[:page] = page
+        end
+
+        unless per_page.nil?
+          params[:per_page] = per_page
+        end
+
+        unless updated_since.nil?
+          params[:updated_since] = updated_since.to_i
+        end
+
+        unless zipcode.nil?
+          params[:zipcode] = zipcode
+
+          unless max_distance_miles.nil?
+            params[:max_dist] = max_distance_miles
+          end
+        end
+
+        get(path: "/organizations/#{esc(organization_id)}/events", params: params)
+      end
+    end
+  end
+end

data/lib/mobilize_america_client/request.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module MobilizeAmericaClient
+  module Request
+    API_DOMAIN = 'events.mobilizeamerica.io'.freeze
+    API_BASE_PATH = '/api/v1'.freeze
+
+    def get(path:, params: {})
+      request(method: :get, path: path, params: params)
+    end
+
+    private
+
+    def esc(untrusted)
+      CGI.escape(untrusted.to_s)
+    end
+
+    def request(method:, path:, params: {}, body: {})
+      response = connection.send(method) do |req|
+        req.path = "#{API_BASE_PATH}#{path}"
+        req.params = params
+        req.headers['Content-Type'] = 'application/json'
+        req.body = ::JSON.generate(body) unless body.empty?
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/mobilize-america-client.gemspec

@@ -0,0 +1,70 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: mobilize-america-client 0.3.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "mobilize-america-client".freeze
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Jacinda Moore".freeze]
+  s.date = "2019-03-05"
+  s.email = "jacinda@controlshiftlabs.com".freeze
+  s.executables = ["console".freeze, "setup".freeze]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    "CODE_OF_CONDUCT.md",
+    "Gemfile",
+    "LICENSE",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/console",
+    "bin/setup",
+    "lib/mobilize_america_client.rb",
+    "lib/mobilize_america_client/client.rb",
+    "lib/mobilize_america_client/client/events.rb",
+    "lib/mobilize_america_client/request.rb",
+    "mobilize-america-client.gemspec",
+    "spec/client/events_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/controlshift/mobilize_america_client".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.3".freeze
+  s.summary = "Client gem for the MobilizeAmerica API".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>.freeze, ["~> 0.15"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+      s.add_development_dependency(%q<rake>.freeze, ["~> 10.0"])
+      s.add_development_dependency(%q<webmock>.freeze, ["~> 3.4"])
+    else
+      s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+      s.add_dependency(%q<rake>.freeze, ["~> 10.0"])
+      s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
+    end
+  else
+    s.add_dependency(%q<faraday>.freeze, ["~> 0.15"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+    s.add_dependency(%q<rake>.freeze, ["~> 10.0"])
+    s.add_dependency(%q<webmock>.freeze, ["~> 3.4"])
+  end
+end
+

data/spec/client/events_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+RSpec.describe MobilizeAmericaClient::Client::Events do
+  let(:standard_headers) { {'Content-Type' => 'application/json'} }
+
+  subject { MobilizeAmericaClient::Client.new }
+
+  describe '#organization_events' do
+    let(:org_id) { 123 }
+    let(:events_url) { "https://#{MobilizeAmericaClient::Client::API_DOMAIN}/api/v1/organizations/#{org_id}/events" }
+    let(:response) { {'data' => [{'id' => 1, 'description' => 'event 1'}, {'id' => 2, 'description' => 'event 2'}]} }
+
+    it 'should call the endpoint and return JSON' do
+      stub_request(:get, events_url).with(headers: standard_headers).to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id)).to eq response
+    end
+
+    it 'should escape the organization ID' do
+      expected_url = "https://#{MobilizeAmericaClient::Client::API_DOMAIN}/api/v1/organizations/foo%2Fbar/events"
+      stub_request(:get, expected_url).with(headers: standard_headers).to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: 'foo/bar')).to eq response
+    end
+
+    it 'should support an updated_since parameter' do
+      updated_since = Time.new
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {updated_since: updated_since.to_i})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, updated_since: updated_since)).to eq response
+    end
+
+    it 'should support a zipcode parameter' do
+      zipcode = '23456'
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {zipcode: zipcode})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, zipcode: zipcode)).to eq response
+    end
+
+    it 'should support a max_dist parameter to go with zipcode' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {zipcode: '23456', max_dist: 100})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, zipcode: '23456', max_distance_miles: 100)).to eq response
+    end
+
+    it 'should support pagination parameters' do
+      stub_request(:get, events_url)
+        .with(headers: standard_headers, query: {page: 2, per_page: 100})
+        .to_return(body: response.to_json)
+      expect(subject.organization_events(organization_id: org_id, page: 2, per_page: 100)).to eq response
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require "bundler/setup"
+require 'rspec'
+require 'webmock/rspec'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "mobilize_america_client"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include WebMock::API
+
+  config.before :each do
+    WebMock.reset!
+  end
+
+  config.after :each do
+    WebMock.reset!
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mobilize-america-client
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Jacinda Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: jacinda@controlshiftlabs.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- LICENSE.txt
+- README.md
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- lib/mobilize_america_client.rb
+- lib/mobilize_america_client/client.rb
+- lib/mobilize_america_client/client/events.rb
+- lib/mobilize_america_client/request.rb
+- mobilize-america-client.gemspec
+- spec/client/events_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/controlshift/mobilize_america_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Client gem for the MobilizeAmerica API
+test_files: []