mobilize-america-client 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12aa69da81126f0f2d45a23926cf1c72f0c50b6043b14be748a67683763a6ba7
-  data.tar.gz: cab2e8b1f0b12122d3fbd6ef4752b1f14fe1eac360b58515654af74795a93e47
+  metadata.gz: 3be8d8de92d42072ed7e068bc049479f01132a72e957ca4646bf54247eeb17df
+  data.tar.gz: 4956ea1496d3da6895fd07a3ab051781b93f4e9606468989ce7cdad33816bfe2
 SHA512:
-  metadata.gz: 42e2b43747a196c8a0cdf27dd787e8cc650fddbbf04a44fd0af3cfdc7a163d429aef5790221d590eac87d87e5c2eb7183749417738dddc04c8ad914ca905e1bd
-  data.tar.gz: beb749323b9cc4f0e3e019ad7da3b7bef61afac440003f7537939e3f8f1672ff6f9da6bf6688b821217d71d020129e9f4764f5533c17fcf0d320f6ff57f9129f
+  metadata.gz: 710e02c68d9f508259129cbb5cf8b16de836c02d5d8c2a9943d1a60489c8c2775c82dff77afb8c0ed54e2b81e861c5be71feefd82e9e0f0c045b6094f76706d1
+  data.tar.gz: fe215dcaabe4358f455cfffbd900ab29ab203d11d25c8b8f9675100d65751c889f2a38fe6a71151fcd134b268940ad1118efc8d2d9780c57383c7e4e4d211c73

data/.github/workflows/ci.yml

@@ -6,9 +6,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.2.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rspec
@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.2.1
           bundler-cache: true
       - run: bundle install
       - run: bundle exec rubocop

data/README.md

@@ -22,12 +22,12 @@ Or install it yourself as:
 
 ## Configuration
 
-By default, the client accesses the public production instance without authentication. 
+By default, the client accesses the public production instance without authentication.
 
 `client = MobilizeAmericaClient::Client.new`
 
 It is also possible to provide an API key to the client to make authenticated requests, or to specify
-other endpoints. 
+other endpoints.
 
 `client = MobilizeAmericaClient::Client.new(api_key: 'abc123', api_domain: 'staging-api.mobilize.us')`
 
@@ -37,13 +37,18 @@ other endpoints.
 Retrieve a list of organizations
 `client.organizations(page: 2, per_page: 50)`
 
-
 Retrieve a list of an organization's events
 `client.organization_events(organization_id: 123)`
 
 Retrieve a specific event
 `client.organization_event(organization_id: 123, event_id: 123)`
 
+Retrieve a list of attendances for a specific event
+`client.organization_event_attendances(organization_id: 123, event_id: 123)`
+
+Retrieve a list of an organization's attendandes
+`client.organization_attendances(organization_id: 123)`
+
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.1

data/lib/mobilize_america_client/client/attendances.rb

@@ -0,0 +1,23 @@
+module MobilizeAmericaClient
+  class Client
+    module Attendances
+      def organization_attendances(organization_id:, updated_since: nil, page: nil, per_page: nil)
+        params = {}
+
+        unless updated_since.nil?
+          params[:updated_since] = updated_since.to_i
+        end
+
+        unless page.nil?
+          params[:page] = page
+        end
+
+        unless per_page.nil?
+          params[:per_page] = per_page
+        end
+
+        get(path: "/organizations/#{esc(organization_id)}/attendances", params: params)
+      end
+    end
+  end
+end

data/lib/mobilize_america_client/client.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'mobilize_america_client/client/attendances'
 require 'mobilize_america_client/client/enums'
 require 'mobilize_america_client/client/events'
 require 'mobilize_america_client/client/organizations'
@@ -19,6 +20,7 @@ module MobilizeAmericaClient
     end
 
     include MobilizeAmericaClient::Request
+    include MobilizeAmericaClient::Client::Attendances
     include MobilizeAmericaClient::Client::Enums
     include MobilizeAmericaClient::Client::Events
     include MobilizeAmericaClient::Client::Organizations

data/lib/mobilize_america_client/errors.rb

@@ -1,4 +1,7 @@
 module MobilizeAmericaClient
   class NotFoundError < StandardError
   end
+
+  class UnauthorizedError < StandardError
+  end
 end

data/lib/mobilize_america_client/request.rb

@@ -32,6 +32,10 @@ module MobilizeAmericaClient
         req.body = ::JSON.generate(body) unless body.empty?
       end
 
+      if response.status == 401
+        raise MobilizeAmericaClient::UnauthorizedError
+      end
+
       if response.status == 404
         raise MobilizeAmericaClient::NotFoundError
       end

data/mobilize-america-client.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: mobilize-america-client 0.4.0 ruby lib
+# stub: mobilize-america-client 0.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mobilize-america-client".freeze
-  s.version = "0.4.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Grey Moore".freeze]
-  s.date = "2023-02-20"
+  s.date = "2023-03-02"
   s.email = "grey@controlshiftlabs.com".freeze
   s.executables = ["console".freeze, "setup".freeze]
   s.extra_rdoc_files = [
@@ -37,12 +37,14 @@ Gem::Specification.new do |s|
     "example.rb",
     "lib/mobilize_america_client.rb",
     "lib/mobilize_america_client/client.rb",
+    "lib/mobilize_america_client/client/attendances.rb",
     "lib/mobilize_america_client/client/enums.rb",
     "lib/mobilize_america_client/client/events.rb",
     "lib/mobilize_america_client/client/organizations.rb",
     "lib/mobilize_america_client/errors.rb",
     "lib/mobilize_america_client/request.rb",
     "mobilize-america-client.gemspec",
+    "spec/client/attendances_spec.rb",
     "spec/client/client_spec.rb",
     "spec/client/enums_spec.rb",
     "spec/client/events_spec.rb",

data/spec/client/attendances_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe MobilizeAmericaClient::Client::Attendances do
+  let(:api_key) { 'abcde-123456' }
+  let(:expected_headers) { {'Content-Type' => 'application/json', 'Authorization' => "Bearer #{api_key}"} }
+  let(:base_url) { "https://#{MobilizeAmericaClient::Client::API_DOMAIN}#{MobilizeAmericaClient::Client::API_BASE_PATH}" }
+
+  subject { MobilizeAmericaClient::Client.new(api_key: api_key) }
+
+  describe '#organization_attendances' do
+    let(:org_id) { 123 }
+    let(:attendances_url) { "#{base_url}/organizations/#{org_id}/attendances" }
+    let(:response) { {'data' => [{'id' => 1, 'event' => {'id' => 1111}}, {'id' => 2, 'event' => {'id' => 2222}}]} }
+
+    context 'unauthenticated request' do
+      let(:api_key) { nil }
+
+      it 'should raise if response status is 401' do
+        stub_request(:get, attendances_url).with(headers: {'Content-Type' => 'application/json'}).to_return(status: 401, body: {error: 'unauthorized'}.to_json)
+
+        expect { subject.organization_attendances(organization_id: org_id) }.to raise_error MobilizeAmericaClient::UnauthorizedError
+      end
+    end
+
+    it 'should raise if response status is 404' do
+      stub_request(:get, attendances_url).with(headers: expected_headers).to_return(status: 404, body: {error: 'not found'}.to_json)
+
+      expect { subject.organization_attendances(organization_id: org_id) }.to raise_error MobilizeAmericaClient::NotFoundError
+    end
+
+    it 'should call the endpoint and return JSON' do
+      stub_request(:get, attendances_url).with(headers: expected_headers).to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: org_id)).to eq(response)
+    end
+
+    it 'should escape the organization ID' do
+      expected_url = "#{base_url}/organizations/foo%2Fbar/attendances"
+      stub_request(:get, expected_url).with(headers: expected_headers).to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: 'foo/bar')).to eq(response)
+    end
+
+    it 'should support an updated_since parameter' do
+      updated_since = Time.new
+      stub_request(:get, attendances_url)
+        .with(headers: expected_headers, query: {updated_since: updated_since.to_i})
+        .to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: org_id, updated_since: updated_since)).to eq(response)
+    end
+
+    it 'should support pagination parameters' do
+      stub_request(:get, attendances_url)
+        .with(headers: expected_headers, query: {page: 2, per_page: 100})
+        .to_return(body: response.to_json)
+      expect(subject.organization_attendances(organization_id: org_id, page: 2, per_page: 100)).to eq(response)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobilize-america-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Grey Moore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,12 +150,14 @@ files:
 - example.rb
 - lib/mobilize_america_client.rb
 - lib/mobilize_america_client/client.rb
+- lib/mobilize_america_client/client/attendances.rb
 - lib/mobilize_america_client/client/enums.rb
 - lib/mobilize_america_client/client/events.rb
 - lib/mobilize_america_client/client/organizations.rb
 - lib/mobilize_america_client/errors.rb
 - lib/mobilize_america_client/request.rb
 - mobilize-america-client.gemspec
+- spec/client/attendances_spec.rb
 - spec/client/client_spec.rb
 - spec/client/enums_spec.rb
 - spec/client/events_spec.rb