demio-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4cd193d6d33811121095b87cb6436c2b306cf0a
+  data.tar.gz: cae5fe432d0dc3460b98a5c3b2b7acdf00ca9eaa
+SHA512:
+  metadata.gz: 7e1d3fcd85ea5b1a89a12a48205da18a60d01b6f6800dbd5d7d083f8bcfadb16f1b744ef4d2c9fe7d05037a6f2010faabb2658b95b6666d7a56208eed6bef95f
+  data.tar.gz: 4311fe39548a57b6b1cafe78e240b2074d8d90d2f6e41cef529987cf10c576b1172104daa7873c934acfb6ad0e312ac87436728e711fd6fee4e17a3c748a8bdf

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status
+.DS_Store
+
+# Dev
+dev_notes.md

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,46 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - "demio-ruby.gemspec"
+    - "Gemfile"
+    - "Rakefile"
+    - 'vendor/**/*' # Fixes weird Travis CI incorrect cop issue
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength: 
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 17
+
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: no_comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: no_comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-06-17 13:13:02 -0500 using RuboCop version 0.56.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,9 @@
+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

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 robyn@yuraki.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,6 @@
+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

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    demio-ruby (0.1.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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      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)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.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)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  demio-ruby!
+  pry (~> 0.10.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.57.1)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robyn-Dale Samuda
+
+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,88 @@
+# Demio Ruby Client
+
+[![Build Status](https://travis-ci.org/samudary/demio-ruby.svg?branch=master)](https://travis-ci.org/samudary/demio-ruby)
+
+A Ruby gem for interacting with the [Demio API](https://publicdemioapi.docs.apiary.io/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'demio-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install demio-ruby
+
+## Usage
+
+Retrieve your API key and API secret from [here](https://my.demio.com/manage/api-details) and initialize the client:
+
+```ruby
+client = Demio::Client.new(
+  api_secret: "YOUR API SECRET",
+  api_key: "YOUR API KEY"
+)
+```
+
+### Methods
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List events                | `#events`                                            |
+| Fetch an event             | `#event(event_id)`                                   |
+| Fetch event date info      | `#event_date(event_id, date_id)`                     |
+| Register a registrant      | `#register(payload = {})`                            |
+| Ping                       | `#ping`                                              |
+
+
+**Examples**
+
+```ruby
+client = Demio::Client.new(
+  api_secret: "YOUR API SECRET",
+  api_key: "YOUR API KEY"
+)
+
+payload = {
+  "id": 56458,
+  "name": "Jane Doe",
+  "email": "jane.doe@gmail.com"
+}
+
+response = client.register(payload)
+response.code
+# => "200"
+
+JSON.parse(response.body)
+# => {"hash"=>"ADv07WFv0RNDQZoF", "join_link"=>"https://event.demio.com/simulated-webinar/ADv07WFv0RNDQZoF"}
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and rubocop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [here](https://github.com/samudary/demio-ruby/issues). 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.
+
+1. Fork it ( https://github.com/samudary/demio-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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 project’s codebases and ther environments is expected to follow the [code of conduct](https://github.com/samudary/demio-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "demio"
+require "pry"
+
+# 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/demio-ruby.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "demio/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "demio-ruby"
+  spec.version       = Demio::VERSION
+  spec.authors       = ["Robyn-Dale Samuda"]
+  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.homepage      = "https://github.com/samudary/demio-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  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"
+end

data/lib/demio.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "demio/version"
+require "demio/client"

data/lib/demio/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "demio/errors"
+require "demio/event"
+require "demio/event_date"
+require "demio/events"
+require "demio/register"
+require "json"
+require "net/http"
+require "uri"
+
+module Demio
+  class Client
+    include Event
+    include EventDate
+    include Events
+    include Register
+
+    attr_reader :api_key, :api_secret
+
+    def initialize(options = {})
+      @api_key = options[:api_key]
+      @api_secret = options[:api_secret]
+    end
+
+    def get(uri)
+      make_request(Net::HTTP::Get, uri)
+    end
+
+    def put(uri, payload)
+      make_request(Net::HTTP::Put, uri, payload)
+    end
+
+    def ping
+      make_request(
+        Net::HTTP::Get,
+        "ping/query?api_key=#{api_key}&api_secret=#{api_secret}"
+      )
+    end
+
+    private
+
+    def make_request(verb_klass, uri, payload = {}, limit = 10)
+      raise TooManyRedirectsError, "too many HTTP redirects" if limit.zero?
+
+      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
+      end
+    end
+
+    def create_headers(request)
+      request["Api-Key"] = api_key
+      request["Api-Secret"] = api_secret
+      request["Content-Type"] = "application/json"
+      request["User-Agent"] = "Demio Ruby Client - #{Demio::VERSION}"
+      request
+    end
+
+    def format_uri(path)
+      URI(base_uri + path)
+    end
+
+    def base_uri
+      "https://my.demio.com/api/v1/"
+    end
+  end
+end

data/lib/demio/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Demio
+  class TooManyRedirectsError < StandardError; end
+end

data/lib/demio/event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Demio
+  class Client
+    module Event
+      # Fetches a single event from Demio
+      #
+      # @param id [String]
+      # @return [Net::HTTPCreated]
+      def event(id)
+        get "event/#{id}"
+      end
+    end
+  end
+end

data/lib/demio/event_date.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Demio
+  class Client
+    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}"
+      end
+    end
+  end
+end

data/lib/demio/events.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Demio
+  class Client
+    module Events
+      # Fetches all events from Demio
+      #
+      # @return [Net::HTTPCreated]
+      def events
+        get "events"
+      end
+    end
+  end
+end

data/lib/demio/register.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Demio
+  class Client
+    module Register
+      # Adds a registrant to an event in Demio
+      #
+      # @param payload [Hash]
+      # @return [Net::HTTPCreated]
+      def register(payload = {})
+        put "event/register", payload
+      end
+    end
+  end
+end

data/lib/demio/version.rb

@@ -0,0 +1,3 @@
+module Demio
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: demio-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robyn-Dale Samuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !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: A wrapper for interacting with the Demio API
+email:
+- robyn@yuraki.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demio-ruby.gemspec
+- lib/demio.rb
+- lib/demio/client.rb
+- lib/demio/errors.rb
+- lib/demio/event.rb
+- lib/demio/event_date.rb
+- lib/demio/events.rb
+- lib/demio/register.rb
+- lib/demio/version.rb
+homepage: https://github.com/samudary/demio-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A wrapper for interacting with the Demio API
+test_files: []