demio-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4cd193d6d33811121095b87cb6436c2b306cf0a
-  data.tar.gz: cae5fe432d0dc3460b98a5c3b2b7acdf00ca9eaa
+SHA256:
+  metadata.gz: 794b5a958104aec0cdc5fabb7d9fa802eef1e0d3c76e609a6f788216d6dac50e
+  data.tar.gz: 76a4eb0d171dc6339d42f292707cdc638a7de99e2c502403dbcce54403f47920
 SHA512:
-  metadata.gz: 7e1d3fcd85ea5b1a89a12a48205da18a60d01b6f6800dbd5d7d083f8bcfadb16f1b744ef4d2c9fe7d05037a6f2010faabb2658b95b6666d7a56208eed6bef95f
-  data.tar.gz: 4311fe39548a57b6b1cafe78e240b2074d8d90d2f6e41cef529987cf10c576b1172104daa7873c934acfb6ad0e312ac87436728e711fd6fee4e17a3c748a8bdf
+  metadata.gz: 7f169723c782d57faf8bbf011677e2c29faffd8628c7dfcacf46026af3ad2803d399ba6affdfcec52954106b6c221d21122be7540f3b7cfa61b03bcf1f6cce7b
+  data.tar.gz: 24f712997e3d648248cb25770e1fa6ce0fe1589b7125b19243aec5929558aacfa9a342d56708fd3d81db28d9f81f5ee66a1c4dbad5d788399a09e988953b9816

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Rubocop linting
+      run: bundle exec rubocop

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - "demio-ruby.gemspec"
     - "Gemfile"
     - "Rakefile"
-    - 'vendor/**/*' # Fixes weird Travis CI incorrect cop issue
+    - "vendor/**/*" # Fixes weird Travis CI incorrect cop issue
 
 Metrics/BlockLength:
   Exclude:

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in demio_ruby.gemspec
 gemspec

data/Gemfile.lock

@@ -1,73 +1,73 @@
 PATH
   remote: .
   specs:
-    demio-ruby (0.1.0)
+    demio-ruby (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hashdiff (0.3.7)
-    jaro_winkler (1.5.1)
-    method_source (0.8.2)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    public_suffix (3.0.2)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubocop (0.57.2)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
-    slop (3.6.0)
-    unicode-display_width (1.4.0)
-    webmock (3.4.2)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2.23)
   demio-ruby!
-  pry (~> 0.10.3)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.57.1)
-  webmock (~> 3.4)
+  pry (~> 0.14.1)
+  rake (~> 13.0.6)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.18.3)
+  webmock (~> 3.13.0)
 
 BUNDLED WITH
-   1.16.1
+   2.2.23

data/README.md

@@ -1,6 +1,7 @@
 # Demio Ruby Client
 
-[![Build Status](https://travis-ci.org/samudary/demio-ruby.svg?branch=master)](https://travis-ci.org/samudary/demio-ruby)
+![example workflow](https://github.com/samudary/demio-ruby/actions/workflows/ruby.yml/badge.svg)
+
 
 A Ruby gem for interacting with the [Demio API](https://publicdemioapi.docs.apiary.io/).
 
@@ -9,7 +10,7 @@ A Ruby gem for interacting with the [Demio API](https://publicdemioapi.docs.apia
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'demio-ruby'
+gem "demio-ruby", require: "demio"
 ```
 
 And then execute:
@@ -37,7 +38,8 @@ client = Demio::Client.new(
 | :------------------------- | :--------------------------------------------------- |
 | List events                | `#events`                                            |
 | Fetch an event             | `#event(event_id)`                                   |
-| Fetch event date info      | `#event_date(event_id, date_id)`                     |
+| Fetch event date info      | `#event_date(event_id, event_date_id)`               |
+| Fetch participants list    | `#participants(event_date_id)`                       |
 | Register a registrant      | `#register(payload = {})`                            |
 | Ping                       | `#ping`                                              |
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "demio"

data/demio-ruby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["robyn@yuraki.com"]
 
   spec.summary       = "A wrapper for interacting with the Demio API"
-  spec.description   = "A wrapper for interacting with the Demio API"
+  spec.description   = "Supports all methods for interacting with the Demio API as described at https://publicdemioapi.docs.apiary.io/"
   spec.homepage      = "https://github.com/samudary/demio-ruby"
   spec.license       = "MIT"
 
@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.57.1"
-  spec.add_development_dependency "pry", "~> 0.10.3"
-  spec.add_development_dependency "webmock", "~> 3.4"
+  spec.add_development_dependency "bundler", "~> 2.2.23"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "~> 1.18.3"
+  spec.add_development_dependency "pry", "~> 0.14.1"
+  spec.add_development_dependency "webmock", "~> 3.13.0"
 end

data/lib/demio/client.rb

@@ -4,6 +4,7 @@ require "demio/errors"
 require "demio/event"
 require "demio/event_date"
 require "demio/events"
+require "demio/participants"
 require "demio/register"
 require "json"
 require "net/http"
@@ -14,10 +15,13 @@ module Demio
     include Event
     include EventDate
     include Events
+    include Participants
     include Register
 
     attr_reader :api_key, :api_secret
 
+    REQUEST_REDIRECT_FOLLOW_LIMIT = 10
+
     def initialize(options = {})
       @api_key = options[:api_key]
       @api_secret = options[:api_secret]
@@ -40,28 +44,33 @@ module Demio
 
     private
 
-    def make_request(verb_klass, uri, payload = {}, limit = 10)
-      raise TooManyRedirectsError, "too many HTTP redirects" if limit.zero?
+    def make_request(verb_klass, uri, payload = {}, request_limit = REQUEST_REDIRECT_FOLLOW_LIMIT)
+      raise TooManyRedirectsError, "too many HTTP redirects" if request_limit.zero?
 
-      uri = format_uri(uri)
+      uri = redirected_request?(request_limit) ? URI(uri) : format_uri(uri)
 
       Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        request = verb_klass.new uri
-        request = create_headers(request)
-
-        request.body = payload.to_json if verb_klass == Net::HTTP::Put
-
-        response = http.request request
-
-        case response
-        when Net::HTTPSuccess then
-          response
-        when Net::HTTPRedirection then
-          location = response["location"]
-          make_request(verb_klass, location, payload, limit - 1)
-        else
-          response.value
-        end
+        response = http.request(create_request(verb_klass, uri, payload))
+        handle_response(response, verb_klass, payload, request_limit)
+      end
+    end
+
+    def create_request(verb_klass, uri, payload)
+      request = verb_klass.new(uri)
+      request = create_headers(request)
+      request.body = payload.to_json if verb_klass == Net::HTTP::Put
+      request
+    end
+
+    def handle_response(response, verb_klass, payload, request_limit)
+      case response
+      when Net::HTTPSuccess
+        response
+      when Net::HTTPRedirection
+        location = response["Location"]
+        make_request(verb_klass, location, payload, request_limit - 1)
+      else
+        response.value
       end
     end
 
@@ -73,6 +82,10 @@ module Demio
       request
     end
 
+    def redirected_request?(request_limit)
+      request_limit < REQUEST_REDIRECT_FOLLOW_LIMIT
+    end
+
     def format_uri(path)
       URI(base_uri + path)
     end

data/lib/demio/event.rb

@@ -6,9 +6,11 @@ module Demio
       # Fetches a single event from Demio
       #
       # @param id [String]
-      # @return [Net::HTTPCreated]
-      def event(id)
-        get "event/#{id}"
+      # @param active [Boolean]
+      # @return [Net::HTTPOk]
+      def event(id, active = nil)
+        active_param = active ? "?active=#{active}" : nil
+        get "event/#{id}#{active_param}"
       end
     end
   end

data/lib/demio/event_date.rb

@@ -5,11 +5,11 @@ module Demio
     module EventDate
       # Fetches info about a specific date from Demio
       #
-      # @param id [String]
-      # @param date_id [String]
-      # @return [Net::HTTPCreated]
-      def event_date(id, date_id)
-        get "event/#{id}/#{date_id}"
+      # @param event_id [String]
+      # @param event_date_id [String]
+      # @return [Net::HTTPOk]
+      def event_date(event_id, event_date_id)
+        get "event/#{event_id}/date/#{event_date_id}"
       end
     end
   end

data/lib/demio/events.rb

@@ -5,9 +5,11 @@ module Demio
     module Events
       # Fetches all events from Demio
       #
-      # @return [Net::HTTPCreated]
-      def events
-        get "events"
+      # @param type [String]
+      # @return [Net::HTTPOk]
+      def events(type = nil)
+        type_param = type ? "?type=#{type}" : nil
+        get "events#{type_param}"
       end
     end
   end

data/lib/demio/participants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Demio
+  class Client
+    module Participants
+      # Returns Event Date participants list
+      #
+      # @param event_date_id [String]
+      # @params status [String]
+      # @return [Net::HTTPOk]
+      def participants(event_date_id, status = nil)
+        status_param = status ? "?status=#{status}" : nil
+        get "report/#{event_date_id}/participants#{status_param}"
+      end
+    end
+  end
+end

data/lib/demio/register.rb

@@ -4,6 +4,7 @@ module Demio
   class Client
     module Register
       # Adds a registrant to an event in Demio
+      # Docs: https://publicdemioapi.docs.apiary.io/#reference/events/register/register
       #
       # @param payload [Hash]
       # @return [Net::HTTPCreated]

data/lib/demio/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Demio
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: demio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robyn-Dale Samuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,85 +16,86 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.23
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: 1.18.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: 1.18.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-description: A wrapper for interacting with the Demio API
+        version: 3.13.0
+description: Supports all methods for interacting with the Demio API as described
+  at https://publicdemioapi.docs.apiary.io/
 email:
 - robyn@yuraki.com
 executables:
@@ -103,11 +104,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -123,6 +125,7 @@ files:
 - lib/demio/event.rb
 - lib/demio/event_date.rb
 - lib/demio/events.rb
+- lib/demio/participants.rb
 - lib/demio/register.rb
 - lib/demio/version.rb
 homepage: https://github.com/samudary/demio-ruby
@@ -144,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A wrapper for interacting with the Demio API

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-  - 2.4.0
-  - 2.3.0
-  - 2.2.0
-before_install:
-  - gem install bundler -v 1.16.1