big_marker_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1a6a622923e26061eda112840cf1945fdad94ec0f6762639e12734cad427aba
+  data.tar.gz: 138e902bd344d8db58402ba439981c6a93e0a2e570ef2412692e49dc6d67a016
+SHA512:
+  metadata.gz: 51781618326aa7412c2ef978842394e6de4a83d093c5b18b85be4e0331d5c0c1a46c6c908f9d613732898c1416dd7cbadbaccb7d3f2f46db1e641c123620e449
+  data.tar.gz: 76bb29ba4b87ef94a2e68edf860c0d44c9795234b17a78006322d1ce35ff99e609f43d98b520b25e05765b74dcdc25d571228fe9fb1f23acff3991f5b492bb3f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - "vendor/**/*"
+    - ".git/**/*"
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "big_marker_client.gemspec"
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at bvk@capinside.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bigmarker_client.gemspec
+gemspec
+
+gem "rake"
+
+group :development do
+  gem "rubocop"
+  gem "rubocop-performance", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "webmock"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 CAPinside GmbH
+
+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,43 @@
+# BigMarkerClient
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bigmarker_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'big_marker_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install big_marker_client
+
+## Usage
+
+As this is a lightweight wrapper around the BigMarker API, mostly refer to [their documentation](https://docs.bigmarker.com/). Most notably the creation of conferences will require a brief look into their requirements.
+
+## 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 the created tag, 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/[USERNAME]/bigmarker_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/bigmarker_client/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 BigMarkerClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bigmarker_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "big_marker_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/big_marker_client/api/v1/conference/registration.rb

@@ -0,0 +1,97 @@
+module BigMarkerClient
+  module Api
+    module V1
+      class Conference
+        class Registration < ::BigMarkerClient::Base
+          LIST_REGISTRANTS              = "/conferences/registrations/{id}".freeze
+          LIST_REGISTRANTS_WITH_FIELDS  = "/conferences/registrations_with_fields/{id}".freeze
+          CREATE_REGISTRANT             = "/conferences/register".freeze
+          DELETE_REGISTRANT             = "/conferences/register".freeze
+          CHECK_REGISTRANT_STATUS       = "/conferences/{id}/check_registration_status".freeze
+
+          class << self
+            ##
+            # list all registrants to a conference.
+            # @param conference_id [String] conference identifier
+            # @param params [Hash] recognized are:
+            # - page: pagination page
+            # - per_page: pagination page size (20*)
+            # @return [BigMarkerClient::Models::Registrant[]]
+            def list(conference_id, params = {})
+              result = get(replace_path_params(path: LIST_REGISTRANTS, replacements: { "{id}": conference_id }), params)
+              return map_to_model_array(result["registrations"]) if result["registrations"]
+
+              result
+            end
+
+            ##
+            # list all registrants to a conference with custom fields.
+            # @param conference_id [String] conference identifier
+            # @param params [Hash] recognized are:
+            # - page: pagination page
+            # - per_page: pagination page size (20*)
+            # @return [BigMarkerClient::Models::Registrant[]]
+            def list_with_fields(conference_id, params = {})
+              result = get(replace_path_params(path: LIST_REGISTRANTS_WITH_FIELDS,
+                                               replacements: { "{id}": conference_id }), params)
+              return map_to_model_array(result["registrations"]) if result["registrations"]
+
+              result
+            end
+
+            ##
+            # registers a participant to a conference.
+            # @param conference_id [String] conference identifier
+            # @param email [String] attendee email
+            # @param first_name [String] attendee first name
+            # @param last_name [String] attendee last name
+            # @param params [Hash] recognized are:
+            # - temporary_password:	a temporary password for registrant
+            # - custom_fields: uRL encoded JSON object, keys are custom_field ids.
+            # - utm_bmcr_source: registrant’s UTM source code
+            # - custom_user_id: external custom user id
+            # @return [String] URL for the participant to enter the conference
+            def register(conference_id, email, first_name, last_name, params = {})
+              create_params = { id: conference_id, email: email, first_name: first_name, last_name: last_name }
+                              .merge(params)
+              result = post(CREATE_REGISTRANT, create_params)
+              return result["conference_url"] if result["conference_url"]
+
+              result
+            end
+
+            ##
+            # remove a participant from a conference
+            # @param conference_id [String] conference identifier
+            # @param email [String] attendee email
+            def unregister(conference_id, email)
+              delete(DELETE_REGISTRANT, { id: conference_id, email: email })
+            end
+
+            ##
+            # check if a person is already registered to a conference. Recognized @params are
+            # @param conference_id [String] conference identifier
+            # @param params [Hash] recognized are:
+            # - bmid: a unique big_marker id of a attendee
+            # - email: the email of an attendee
+            # either of these two are required
+            # @return [String] status (registered. not registered)
+            def check_status(conference_id, params = {})
+              result = get(replace_path_params(path: CHECK_REGISTRANT_STATUS, replacements: { "{id}": conference_id }),
+                           params)
+              return result["registration_status"] if result["registration_status"]
+
+              result
+            end
+
+            private
+
+            def map_to_model_array(hash_array)
+              hash_array.map { |hash| ::BigMarkerClient::Models::Registrant.new(hash) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/big_marker_client/api/v1/conference.rb

@@ -0,0 +1,187 @@
+module BigMarkerClient
+  module Api
+    module V1
+      class Conference < ::BigMarkerClient::Base
+        LIST_CONFERENCES              = "/conferences".freeze
+        SEARCH_CONFERENCES            = "/conferences/search".freeze
+        ASSOCIATED_SERIES_CONFERENCES = "/conferences/get_associated_sessions/{id}".freeze
+        RECURRING_CONFERENCES         = "/conferences/recurring/{id}".freeze
+        CREATE_CONFERENCE             = "/conferences".freeze
+        UPDATE_CONFERENCE             = "/conferences/{id}".freeze
+        GET_CONFERENCE                = "/conferences/{id}".freeze
+        GET_CONFERENCE_PRESENTERS     = "/conferences/{id}/presenters".freeze
+        GET_CONFERENCE_ATTENDEES      = "/conferences/{id}/attendees".freeze
+        DELETE_CONFERENCE             = "/conferences/{id}".freeze
+        ENTER_CONFERENCE              = "/conferences/enter".freeze
+
+        class << self
+          ##
+          # lists all conferences, where date range con only be influenced indirectly.
+          # @param params [Hash] recognized are:
+          # - role: Filter by member role (all*, hosting, attending)
+          # - type: Filter by conference type (future*, past, all, multiple_times, future_do_not_include_happening,
+          #                                    future_with_24_hour_room, past_with_recording, always_open, happening_now)
+          # - query: search in conference title
+          # - page: pagination page
+          # - page_count: pagination page size (20*), ATTENTION: this is called per_page everywhere else!
+          # @return [BigMarkerClient::Models::Conference[]]
+          def list(params = {})
+            params["page_count"] ||= params["per_page"] if params["per_page"]
+            result = get(LIST_CONFERENCES, params)
+            return map_to_model_array(result["conferences"]) if result["conferences"]
+
+            result
+          end
+
+          ##
+          # search for conferences with specific matching criteria.
+          # @param params [Hash] recognized are:
+          # - title: search in conference title
+          # - start_time: conferences with start time after this date (Unix timestamp)
+          # - end_time: conferences with end time before this date (Unix timestamp)
+          # - conference_ids: select conferences based on their IDs (comma separated)
+          # - presenter_member_ids: select conferences based on their presenters IDs (comma separated)
+          # - role: Filter by member role (all*, hosting, attending)
+          # - type: Filter by conference type (evergreen_parent evergreen_child recurring_parent recurring_child
+          #                                    meetingspace ondemand live_webinar webcast)
+          # - page: pagination page
+          # - per_page: pagination page size (20*)
+          # @return [BigMarkerClient::Models::Conference[]]
+          def search(params = {})
+            result = post(SEARCH_CONFERENCES, params)
+            return map_to_model_array(result["conferences"]) if result["conferences"]
+
+            result
+          end
+
+          ##
+          # get one conference based on it's ID
+          # @param conference_id [String] conference identifier
+          # @return [BigMarkerClient::Models::Conference]
+          def show(conference_id)
+            result = get(replace_path_params(path: GET_CONFERENCE, replacements: { "{id}": conference_id }))
+            return ::BigMarkerClient::Models::Conference.new(result["conference"]) if result["conference"]
+
+            result
+          end
+
+          ##
+          # get series related to a conference.
+          # @param conference_id [String] conference identifier
+          # @param params [Hash] recognized are:
+          # - page: pagination page
+          # - per_page: pagination page size (20*)
+          # @return [BigMarkerClient::Models::Conference[]]
+          def associated_series(conference_id, params = {})
+            result = get(replace_path_params(path: ASSOCIATED_SERIES_CONFERENCES,
+                                             replacements: { "{id}": conference_id }), params)
+            return map_to_model_array(result["conferences"]) if result["conferences"]
+
+            result
+          end
+
+          ##
+          # get child conferences of a parent recurring conference.
+          # @param conference_id [String] conference identifier
+          # @param params [Hash] recognized are:
+          # - start_time: conferences with start time after this date (Unix timestamp)
+          # - end_time: conferences with end time before this date (Unix timestamp)
+          # - page: pagination page
+          # - per_page: pagination page size (20*)
+          # @return [BigMarkerClient::Models::Conference[]]
+          def recurring(conference_id, params = {})
+            result = get(replace_path_params(path: RECURRING_CONFERENCES,
+                                             replacements: { "{id}": conference_id }), params)
+            return map_to_model_array(result["conferences"]) if result["conferences"]
+
+            result
+          end
+
+          ##
+          # update a conference either with a Models::Conference object or single properties as hash
+          # @param conference_id [String] conference identifier
+          # @param body [Hash or BigMarkerClient::Models::Conference]
+          # @return [BigMarkerClient::Models::Conference]
+          def update(conference_id, body = {})
+            body = body.to_h if body.is_a?(::BigMarkerClient::Models::Conference)
+            result = put(replace_path_params(path: UPDATE_CONFERENCE, replacements: { "{id}": conference_id }), body)
+            return ::BigMarkerClient::Models::Conference.new(result["conference"]) if result["conference"]
+
+            result
+          end
+
+          ##
+          # create a conference either with a Models::Conference object or single properties as hash
+          # @param body [Hash or BigMarkerClient::Models::Conference]
+          # @return [BigMarkerClient::Models::Conference]
+          def create(body = {})
+            body = body.to_h if body.is_a?(::BigMarkerClient::Models::Base)
+            result = post(CREATE_CONFERENCE, body)
+            return ::BigMarkerClient::Models::Conference.new(result["conference"]) if result["conference"]
+
+            result
+          end
+
+          ##
+          # delete a conference
+          # @param conference_id [String] conference identifier
+          def destroy(conference_id)
+            delete(replace_path_params(path: DELETE_CONFERENCE, replacements: { "{id}": conference_id }))
+          end
+
+          ##
+          # enter a conference towards an enterprise iframe,
+          # @param conference_id [String] conference identifier
+          # @param name [String] attendee name
+          # @param email [String] attendee email
+          # @param body [Hash] recognized are:
+          # - register_attendee_to_webinar: true/false*
+          # - attendee_first_name: First name of the attendee for registration (see register_attendee_to_webinar)
+          # - attendee_last_name: Last name of the attendee for registration (see register_attendee_to_webinar)
+          # - custom_user_id: an external user id for matching
+          # - role: the role of the user that is entering the webinar (attendee*, moderator, presenter)
+          # - exit_uri: URL that attendees will be redirected to after the webinar
+          # @return [Hash] enter_token: auth token for conference, enter_uri: URL to enter conference
+          def enter(conference_id, name, email, body = {})
+            body.merge!(id: conference_id, attendee_name: name, attendee_email: email)
+            post(ENTER_CONFERENCE, body)
+          end
+
+          ##
+          # Get all presenters of a conference.
+          # @param conference_id [String] conference identifier
+          # @return [BigMarkerClient::Models::Presenter[]]
+          def presenters(conference_id)
+            result = get(replace_path_params(path: GET_CONFERENCE_PRESENTERS, replacements: { "{id}": conference_id }))
+            if result["presenters"]
+              return map_to_model_array(result["presenters"], ::BigMarkerClient::Models::Presenter)
+            end
+
+            result
+          end
+
+          ##
+          # Get all registered attendees of a conference. Recognized @params are:
+          # @param conference_id [String] conference identifier
+          # @param params [Hash] recognized are:
+          # - page: pagination page
+          # - per_page: pagination page size (20*)
+          # @return [BigMarkerClient::Models::Attendee[]]
+          def attendees(conference_id, params = {})
+            result = get(replace_path_params(path: GET_CONFERENCE_ATTENDEES,
+                                             replacements: { "{id}": conference_id }), params)
+            return map_to_model_array(result["attendees"], ::BigMarkerClient::Models::Attendee) if result["attendees"]
+
+            result
+          end
+
+          private
+
+          def map_to_model_array(hash_array, model_class = ::BigMarkerClient::Models::Conference)
+            hash_array.map { |hash| model_class.new(hash) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/big_marker_client/api/v1/presenter.rb

@@ -0,0 +1,63 @@
+module BigMarkerClient
+  module Api
+    module V1
+      class Presenter < ::BigMarkerClient::Base
+        LIST_PRESENTER_CONFERENCES = "/presenters/{id}/list_conferences".freeze
+        CREATE_PRESENTER           = "/presenters".freeze
+        UPDATE_PRESENTER           = "/presenters/{id}".freeze
+        DELETE_PRESENTER           = "/presenters/{id}".freeze
+
+        class << self
+          ##
+          # lists all conferences of a presenter
+          # @param member_id [String] BigMarker member id (BMID)
+          # @param channel_id [String] BigMarker channel id
+          # @return [BigMarkerClient::Models::Conference[]]
+          def list_conferences(member_id, channel_id)
+            result = get(replace_path_params(path: LIST_PRESENTER_CONFERENCES, replacements: { "{id}": member_id }),
+                         { channel_id: channel_id })
+            if result["conferences"]
+              return result["conferences"].map { |conference| ::BigMarkerClient::Models::Conference.new(conference) }
+            end
+
+            result
+          end
+
+          ##
+          # update a presenter to a conference either with a Models::Presenter object or single properties as hash
+          # @param member_id [String] BigMarker member identifier (BMID)
+          # @param body [Hash or BigMarkerClient::Models::Presenter]
+          # @return [BigMarkerClient::Models::Presenter]
+          def update(member_id, body = {})
+            body = body.to_h if body.is_a?(::BigMarkerClient::Models::Presenter)
+            result = put(replace_path_params(path: UPDATE_PRESENTER, replacements: { "{id}": member_id }), body)
+            return ::BigMarkerClient::Models::Presenter.new(result["presenter"]) if result["presenter"]
+
+            result
+          end
+
+          ##
+          # add a presenter to a conference either with a Models::Presenter object or single properties as hash
+          # @param conference_id [String] conference identifier
+          # @param body [Hash or BigMarkerClient::Models::Presenter]
+          # @return [BigMarkerClient::Models::Presenter]
+          def create(conference_id, body = {})
+            body = body.to_h if body.is_a?(::BigMarkerClient::Models::Base)
+            body["conference_id"] = conference_id
+            result = post(CREATE_PRESENTER, body)
+            return ::BigMarkerClient::Models::Presenter.new(result["presenter"]) if result["presenter"]
+
+            result
+          end
+
+          ##
+          # remove a presenter from a conference
+          # @param member_id [String] BigMarker member identifier (BMID)
+          def destroy(member_id)
+            delete(replace_path_params(path: DELETE_PRESENTER, replacements: { "{id}": member_id }))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/big_marker_client/base.rb

@@ -0,0 +1,91 @@
+require "typhoeus"
+require "typhoeus/adapters/faraday"
+
+module BigMarkerClient
+  class Base
+    class << self
+      def post(path, body = {})
+        request(verb: :post, path: path, params: body)
+      end
+
+      def put(path, body = {})
+        request(verb: :put, path: path, params: body)
+      end
+
+      def patch(path, body = {})
+        request(verb: :patch, path: path, params: body)
+      end
+
+      def delete(path, body = {})
+        request(verb: :delete, path: path, params: body)
+      end
+
+      def get(path, params = {})
+        request(verb: :get, path: path, params: params)
+      end
+
+      protected
+
+      def replace_path_params(path:, replacements: {})
+        new_path = path.dup
+        replacements.each { |k, v| new_path.gsub!(k.to_s, v) }
+        new_path
+      end
+
+      private
+
+      def request(path:, verb: :get, params: {})
+        check_preconditions(verb, path)
+
+        params = params.to_json unless %w[get delete].include?(verb.to_s)
+        response = http_client.send(verb.to_s, base_url(path), params)
+        parse_body(response.body)
+      end
+
+      def check_preconditions(verb, path)
+        if verb.nil? || path.nil? || BigMarkerClient::Config.api_key.nil?
+          raise ArgumentError, "http_method, path or api key is missing"
+        end
+        raise ArgumentError, "unsupported http_method: #{verb}" unless %w[post put patch delete get].include?(verb.to_s)
+      end
+
+      def http_client
+        conn ||= Faraday.new(url: BigMarkerClient::Config.base_url) do |faraday|
+          faraday = headers(faraday)
+          configure_logging(faraday) if BigMarkerClient::Config.log
+        end
+        conn.adapter :typhoeus
+        conn
+      end
+
+      def headers(adapter)
+        adapter.headers["Content-Type"] = "application/json"
+        adapter.headers["API-KEY"] = BigMarkerClient::Config.api_key unless BigMarkerClient::Config.api_key.nil?
+        adapter
+      end
+
+      def configure_logging(adapter)
+        adapter.response :logger do |logger|
+          logger.instance_variable_get("@options")[:log_level] = :debug if BigMarkerClient::Config.debug
+          logger.filter(/password=([^&]+)/, "password=[FILTERED]")
+          logger.filter(/API-KEY: "(\w*)"/, "API-KEY: [FILTERED]")
+        end
+        adapter
+      end
+
+      def base_url(path)
+        BigMarkerClient::Config.base_url + (path.start_with?("/") ? path : "/#{path}")
+      end
+
+      def parse_body(body)
+        return nil if body.strip == ""
+
+        json = JSON.parse(body)
+        BigMarkerClient::Config.logger.debug(json) if BigMarkerClient::Config.debug
+        json
+      rescue JSON::ParserError
+        raise BigMarkerClient::ResponseError, "invalid response"
+      end
+    end
+  end
+end

data/lib/big_marker_client/config.rb

@@ -0,0 +1,29 @@
+module BigMarkerClient
+  class Config
+    class << self
+      attr_accessor :logger
+      attr_writer :api_key, :base_url, :log, :debug
+
+      def base_url
+        @base_url ||= "https://www.bigmarker.com/api/v1"
+      end
+
+      def api_key
+        @api_key ||= ENV["BIGMARKER_API_KEY"]
+      end
+
+      def log
+        @log ||= false
+      end
+
+      def debug
+        @debug ||= false
+        if @debug && @logger.nil?
+          require "logger"
+          @logger ||= defined?(Rails.logger) ? Rails.logger : ::Logger.new($stdout)
+        end
+        @debug
+      end
+    end
+  end
+end

data/lib/big_marker_client/models/attendee.rb

@@ -0,0 +1,9 @@
+module BigMarkerClient
+  module Models
+    class Attendee < Base
+      attr_accessor :email, :first_name, :last_name, :entered_at, :leaved_at, :total_duration, :engaged_duration,
+                    :chats_count, :qas_count, :polls_count, :polls, :questions, :handouts, :browser_name,
+                    :browser_version, :device_name
+    end
+  end
+end

data/lib/big_marker_client/models/base.rb

@@ -0,0 +1,31 @@
+module BigMarkerClient
+  module Models
+    class Base
+      def initialize(hash)
+        return unless hash.is_a?(Hash)
+
+        known_attributes = self.class.instance_methods
+        hash.each { |k, v| known_attributes.include?(k.to_sym) ? send("#{k}=", v) : warn("missing property: #{k}") }
+      end
+
+      def to_h
+        instance_variables.each_with_object({}) do |var, hash|
+          value = instance_variable_get(var)
+          hash[key(var)] = if value.is_a?(Array) && !value.empty? && value.first.is_a?(::BigMarkerClient::Models::Base)
+                             value.map(&:to_h)
+                           elsif value.is_a?(::BigMarkerClient::Models::Base)
+                             value.to_h
+                           else
+                             value
+                           end
+        end
+      end
+
+      private
+
+      def key(var)
+        var.to_s.sub("@", "")
+      end
+    end
+  end
+end

data/lib/big_marker_client/models/conference.rb

@@ -0,0 +1,77 @@
+module BigMarkerClient
+  module Models
+    ##
+    # for supported values for time_zone please compare [the documentation](https://docs.bigmarker.com/#time-zones)
+    class Conference < Base
+      attr_accessor :id, :title, :event_type, :display_language, :meeting_mode, :type, :conference_copy_id,
+                    :master_webinar_id, :max_attendance, :purpose, :start_time, :duration_minutes, :conference_address,
+                    :custom_event_id, :channel_id, :webcast_mode, :end_time, :moderator_open_time, :audience_open_time,
+                    :first_admin_enter_time, :manual_end_time, :privacy, :exit_url, :enable_registration_email,
+                    :enable_knock_to_enter, :send_reminder_emails_to_presenters, :review_emails,
+                    :poll_results, :enable_ie_safari, :enable_twitter, :auto_invite_all_channel_members,
+                    :send_cancellation_email, :show_reviews, :registration_required_to_view_recording,
+                    :who_can_watch_recording, :show_handout_on_page, :background_image_url, :room_logo, :agenda_topics,
+                    :disclaimer, :recorded, :recording_url, :recording_iframe,
+                    # for conference creation
+                    :sub_url, :enable_dial_in, :time_zone, :schedule_type, :recurring_start_times,
+                    :presenter_advanced_enter_time, :attendee_advanced_enter_time, :webinar_format,
+                    :registration_conf_emails, :send_notification_emails_to_presenters, :webhook_url, :channel_admin_id,
+                    :free_for_all, :room_type, :room_sub_title
+
+      attr_reader :dial_in_information, :preload_files, :presenters, :webinar_stats, :associated_series
+
+      # differences between creation and retrieval, use creation as leading (oh well)
+      alias can_view_poll_results poll_results
+      alias can_view_poll_results= poll_results=
+      alias duration duration_minutes
+      alias duration= duration_minutes=
+      alias enable_review_emails review_emails
+      alias enable_review_emails= review_emails=
+      alias language display_language
+      alias language= display_language=
+      alias copy_webinar_id conference_copy_id
+      alias copy_webinar_id= conference_copy_id=
+
+      def dial_in_information=(dial_in_hash)
+        @dial_in_information = if dial_in_hash.nil? || !dial_in_hash.is_a?(Hash)
+                                 nil
+                               else
+                                 DialInInformation.new(dial_in_hash)
+                               end
+      end
+
+      def preload_files=(file_array)
+        @preload_files = if file_array.nil? || !file_array.is_a?(Array) || file_array.empty?
+                           []
+                         else
+                           file_array.map { |file_hash| PreloadFile.new(file_hash) }
+                         end
+      end
+
+      def presenters=(presenter_array)
+        @presenters = if presenter_array.nil? || !presenter_array.is_a?(Array) || presenter_array.empty?
+                        []
+                      else
+                        presenter_array.map { |presenter_hash| Presenter.new(presenter_hash) }
+                      end
+      end
+
+      def webinar_stats=(webinar_stats_hash)
+        @webinar_stats = if webinar_stats_hash.nil? || !webinar_stats_hash.is_a?(Hash)
+                           nil
+                         else
+                           WebinarStats.new(webinar_stats_hash)
+                         end
+      end
+
+      def associated_series=(series_array)
+        @associated_series = if series_array.nil? || !series_array.is_a?(Array) || series_array.empty?
+                               []
+                             else
+                               # TODO: identify element
+                               series_array.map { |series_hash| series_hash.map { |k, v| "#{k}: #{v}" } }
+                             end
+      end
+    end
+  end
+end

data/lib/big_marker_client/models/dial_in_information.rb

@@ -0,0 +1,8 @@
+module BigMarkerClient
+  module Models
+    class DialInInformation < Base
+      attr_accessor :dial_in_number, :dial_in_id, :dial_in_passcode, :presenter_dial_in_number, :presenter_dial_in_id,
+                    :presenter_dial_in_passcode
+    end
+  end
+end

data/lib/big_marker_client/models/preload_file.rb

@@ -0,0 +1,7 @@
+module BigMarkerClient
+  module Models
+    class PreloadFile < Base
+      attr_accessor :id, :file_name, :file_type, :file_url
+    end
+  end
+end

data/lib/big_marker_client/models/presenter.rb

@@ -0,0 +1,24 @@
+module BigMarkerClient
+  module Models
+    class Presenter < Base
+      attr_accessor :presenter_id, :member_id, :conference_id, :name, :display_on_landing_page, :presenter_first_name,
+                    :presenter_last_name, :presenter_email, :presenter_url, :photo_url, :presenter_dial_in_number,
+                    :presenter_dial_in_id, :presenter_dial_in_passcode, :title, :bio, :can_manage, :is_moderator,
+                    :facebook, :twitter, :linkedin, :website,
+                    # for presenter creation
+                    :presenter_temporary_password, :send_email_invite, :add_to_channel_subscriber_list
+
+      # differences between creation and retrieval, use creation as leading (oh well)
+      alias display_name name
+      alias display_name= name=
+      alias email presenter_email
+      alias email= presenter_email=
+      alias first_name presenter_first_name
+      alias first_name= presenter_first_name=
+      alias last_name presenter_last_name
+      alias last_name= presenter_last_name=
+      alias presenter_image_url photo_url
+      alias presenter_image_url= photo_url=
+    end
+  end
+end

data/lib/big_marker_client/models/registrant.rb

@@ -0,0 +1,8 @@
+module BigMarkerClient
+  module Models
+    class Registrant < Base
+      attr_accessor :email, :first_name, :last_name, :custom_fields, :enter_url, :bmid, :referral_domain, :source,
+                    :tracking_code, :custom_user_id
+    end
+  end
+end

data/lib/big_marker_client/models/webinar_stats.rb

@@ -0,0 +1,7 @@
+module BigMarkerClient
+  module Models
+    class WebinarStats < Base
+      attr_accessor :registrants, :revenue, :total_attendees, :page_views, :invited
+    end
+  end
+end

data/lib/big_marker_client/version.rb

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

data/lib/big_marker_client.rb

@@ -0,0 +1,35 @@
+require "json"
+
+module BigMarkerClient
+  class Error < StandardError; end
+  class ConnectionError < StandardError; end
+  class ClientError < ConnectionError; end
+  class ServerError < ConnectionError; end
+  class ResponseError < ConnectionError; end
+  class NotFound < ResponseError; end
+
+  autoload :Base, "big_marker_client/base"
+  autoload :Config, "big_marker_client/config"
+  autoload :Version, "big_marker_client/version"
+
+  module Api
+    module V1
+      autoload :Conference, "big_marker_client/api/v1/conference"
+      class Conference
+        autoload :Registration, "big_marker_client/api/v1/conference/registration"
+      end
+      autoload :Presenter, "big_marker_client/api/v1/presenter"
+    end
+  end
+
+  module Models
+    autoload :Attendee, "big_marker_client/models/attendee"
+    autoload :Base, "big_marker_client/models/base"
+    autoload :Conference, "big_marker_client/models/conference"
+    autoload :DialInInformation, "big_marker_client/models/dial_in_information"
+    autoload :PreloadFile, "big_marker_client/models/preload_file"
+    autoload :Presenter, "big_marker_client/models/presenter"
+    autoload :Registrant, "big_marker_client/models/registrant"
+    autoload :WebinarStats, "big_marker_client/models/webinar_stats"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: big_marker_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Burkhard Vogel-Kreykenbohm
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Encapsulates calls to the BigMarker API to create ond retrieve conferences,
+  participants, analytics and more
+email:
+- bvk@capinside.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/big_marker_client.rb
+- lib/big_marker_client/api/v1/conference.rb
+- lib/big_marker_client/api/v1/conference/registration.rb
+- lib/big_marker_client/api/v1/presenter.rb
+- lib/big_marker_client/base.rb
+- lib/big_marker_client/config.rb
+- lib/big_marker_client/models/attendee.rb
+- lib/big_marker_client/models/base.rb
+- lib/big_marker_client/models/conference.rb
+- lib/big_marker_client/models/dial_in_information.rb
+- lib/big_marker_client/models/preload_file.rb
+- lib/big_marker_client/models/presenter.rb
+- lib/big_marker_client/models/registrant.rb
+- lib/big_marker_client/models/webinar_stats.rb
+- lib/big_marker_client/version.rb
+homepage: https://gitlab.com/capinside-oss/big_marker_client
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: simple client library to access the BigMarker API
+test_files: []