citrix 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 110512ea1f5aeb8316a68ab64f6f3d795bebf5ac
-  data.tar.gz: 1fd799d1a1990a5d0e2fbf9f2d0c246705bb1d81
+  metadata.gz: a5a06b3c6f0dc327a0bcbcd906dd5348a55dd998
+  data.tar.gz: 32d47b27842f60d00284619696f908da9df02e9a
 SHA512:
-  metadata.gz: 44572a055ba74f874400f883dfc850c7ee9454e7d623c983873ae117b54023bf64ceb52a4c1fd2e32c8f561e9d9fd0852eab739f9f3b5955b27278a1b9aad672
-  data.tar.gz: 59c82e761b0f4b88dd7670ebdb580361d63d59c9871b8c6882fac5f139e9193cc1285910de662cfe4b74a1a4dedba389896c6cbf98b2f6036e5acf4a50394ae4
+  metadata.gz: 3406b08706191fde2506c2fd55d95fcb59111627ea91031fa82190b59a44a5a1a7b776a43a8f27edcdda47eb0188378e937b4ba560876012d6b1079d90e2204f
+  data.tar.gz: a42202ff1e877baea7d5da52558eaf54184da3524d595865f12e197a14d3c019415c69a119137544256461e7a8de0afbb476a7e1ef860a5826d10c13b863671c

data/.travis.yml

@@ -6,3 +6,7 @@ rvm:
 
 gemfile:
   - Gemfile
+
+addons:
+  code_climate:
+    repo_token: 36d1b2992ebb12fef1167de97f900d332f01e75f0b2bc90b3159621585a9ed1e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.1.0
+
+- Initial release

data/CONTRIBUITING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+## Issues
+
+If you want to request a feature or report a bug, please use the following template.
+
+```markdown
+## Description
+
+[Add feature/bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Gem version:
+
+Citrix version: [Add citrix gem version here]
+```
+
+## Writing code
+
+Once you've made your great commits (include tests, please):
+
+1. [Fork](http://help.github.com/forking/) citrix
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. [Create an Issue](http://github.com/fnando/citrix/issues) with a link to your branch
+5. That's it!
+
+Please respect the indentation rules and code style.
+And don't touch the versioning thing.

data/README.md

@@ -1,5 +1,11 @@
 # Citrix
 
+[![Build Status](https://travis-ci.org/fnando/citrix.svg)](https://travis-ci.org/fnando/citrix)
+[![Code Climate](https://codeclimate.com/github/fnando/citrix/badges/gpa.svg)](https://codeclimate.com/github/fnando/citrix)
+[![Test Coverage](https://codeclimate.com/github/fnando/citrix/badges/coverage.svg)](https://codeclimate.com/github/fnando/citrix)
+
+API wrappers for Citrix services like GoToTraining. It includes partial API mapping for GoToTraining.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +22,106 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### GoToTraining
+
+#### Create client
+
+Initialize a client with provided credentials.
+The credentials must be a instance of or
+a Hash accepted by `Citrix::Training::Credentials`.
+
+```ruby
+client = Citrix::Training::Client.build(
+  oauth_token: ENV.fetch('CITRIX_OAUTH_TOKEN'),
+  organizer_key: ENV.fetch('CITRIX_ORGANIZER_KEY'),
+  account_key: ENV.fetch('CITRIX_ACCOUNT_KEY')
+)
+```
+
+#### Create training
+
+```ruby
+response, training = client.trainings.create({
+  name: 'Ruby on Rails',
+  description: 'Getting started with Ruby on Rails',
+  timezone: 'America/Sao_Paulo',
+  dates: [date],
+  web_registration: false,
+  confirmation_email: false,
+  organizers: [organizer]
+})
+
+if response.ok?
+  # Training successfully created!
+else
+  p response.json
+end
+```
+
+#### Get all trainings
+
+Retrieve information on all scheduled trainings for a given organizer.
+
+```ruby
+response, trainings = client.trainings.all
+
+if trainings
+  # Retrieved all trainings
+else
+  p response.json
+end
+```
+
+#### Remove a training
+
+Deletes a scheduled or completed training.
+
+```ruby
+response = client.trainings.remove(training)
+response.ok? #=> successfully removed
+```
+
+#### Add registrant
+
+Register one person, identified by a unique email address, for a training.
+
+```ruby
+response, registrant = client.registrants(training).create({
+  first_name: 'John',
+  last_name: 'Doe',
+  email: 'john@example.com'
+})
+
+if response.ok?
+  # Do something with registrant
+else
+  p response.json
+end
+```
+
+#### Get all registrants
+
+Retrieve details on all registrants for a specific training.
+
+```ruby
+response, registrants = client.registrants(training).all
+
+if response.ok?
+  # Do something with registrants
+else
+  p response.json
+end
+```
+
+#### Remove registrant
+
+This call cancels a registration in a scheduled training for a
+specific registrant.
+
+```ruby
+response = client.registrants(training).remove(registrant)
+response.ok? #=> successfully removed
+```
 
 ## Contributing
 

data/citrix.gemspec

@@ -15,7 +15,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'aitch'
+
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry-meta'
 end

data/lib/citrix.rb

@@ -1 +1,2 @@
 require 'citrix/version'
+require 'citrix/training'

data/lib/citrix/training.rb

@@ -0,0 +1,22 @@
+require 'time'
+
+require 'aitch'
+
+require 'citrix/training/helpers/initializer'
+require 'citrix/training/helpers/http_client'
+require 'citrix/training/credentials'
+require 'citrix/training/client'
+require 'citrix/training/namespace/trainings'
+require 'citrix/training/namespace/registrants'
+require 'citrix/training/resource/training'
+require 'citrix/training/resource/registrant'
+require 'citrix/training/serializer/training'
+require 'citrix/training/serializer/registrant'
+require 'citrix/training/resource/training_date'
+require 'citrix/training/serializer/training_date'
+
+module Citrix
+  module Training
+    API_ENDPOINT = 'https://api.citrixonline.com/G2T/rest'
+  end
+end

data/lib/citrix/training/client.rb

@@ -0,0 +1,38 @@
+module Citrix
+  module Training
+    class Client
+      include Helpers::Initializer
+
+      # Set credentials.
+      attr_accessor :credentials
+
+      # Initialize a client with provided credentials.
+      # The credentials must be a instance of or
+      # a Hash accepted by `Citrix::Training::Credentials`.
+      #
+      #   client = Citrix::Training::Client.build(
+      #     oauth_token: ENV.fetch('CITRIX_OAUTH_TOKEN'),
+      #     organizer_key: ENV.fetch('CITRIX_ORGANIZER_KEY'),
+      #     account_key: ENV.fetch('CITRIX_ACCOUNT_KEY')
+      #   )
+      #
+      def self.build(credentials)
+        new(credentials: Credentials.build(credentials))
+      end
+
+      # Return the training namespace, which include methods for creating and
+      # finding trainings. For additional info, check
+      # `Citrix::Training::Namespace::Trainings`.
+      def trainings
+        Namespace::Trainings.new(credentials: credentials)
+      end
+
+      # Return the registrants namespace, which include methods for creating
+      # registrants. It requires an existing training.
+      # For additional info, check `Citrix::Training::Namespace::Registrants`.
+      def registrants(training)
+        Namespace::Registrants.new(credentials: credentials, training: training)
+      end
+    end
+  end
+end

data/lib/citrix/training/credentials.rb

@@ -0,0 +1,27 @@
+module Citrix
+  module Training
+    class Credentials
+      include Helpers::Initializer
+
+      # Set the OAuth token.
+      # You can use the [Omniauth::Citrix](http://github.com/fnando/omniauth-citrix)
+      # for OAuth2 authentication on Rack-based applications.
+      attr_accessor :oauth_token
+
+      # Set the organizer key.
+      attr_accessor :organizer_key
+
+      # Set the account key.
+      attr_accessor :account_key
+
+      # Initialize a `Citrix::Training::Credentials` instance.
+      def self.build(credentials)
+        if credentials.kind_of?(self)
+          credentials
+        else
+          new(credentials)
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/helpers/http_client.rb

@@ -0,0 +1,33 @@
+module Citrix
+  module Training
+    module Helpers
+      module HttpClient
+        def json_parser
+          http_client.configuration.json_parser
+        end
+
+        def url_for(*args)
+          File.join(API_ENDPOINT, *args.map(&:to_s))
+        end
+
+        def http_client
+          @http_client ||= Aitch::Namespace.new.tap do |ns|
+            ns.configure do |config|
+              if $DEBUG
+                require 'logger'
+                config.logger = Logger.new($stdout)
+              end
+
+              config.user_agent = "Citrix::Rubygems/#{Citrix::VERSION}"
+              config.default_headers = {
+                'Authorization' => -> { "OAuth oauth_token=#{credentials.oauth_token}" },
+                'Accept' => 'application/json',
+                'Content-Type' => 'application/json'
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/helpers/initializer.rb

@@ -0,0 +1,13 @@
+module Citrix
+  module Training
+    module Helpers
+      module Initializer
+        def initialize(attributes = {})
+          attributes.each do |name, value|
+            public_send "#{name}=", value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/namespace/registrants.rb

@@ -0,0 +1,107 @@
+module Citrix
+  module Training
+    module Namespace
+      class Registrants
+        include Helpers::Initializer
+        include Helpers::HttpClient
+
+        # Set the credentials.
+        attr_accessor :credentials
+
+        # Set the training.
+        attr_accessor :training
+
+        # Register one person, identified by a unique email address, for a training.
+        #
+        # Approval is automatic unless payment or approval is required. The
+        # response contains the Confirmation page URL and Join URL for the
+        # registrant.
+        #
+        # NOTE: If some registrants do not receive a confirmation email, the
+        # emails could be getting blocked by their email server due to spam
+        # filtering or a grey-listing setting.
+        #
+        #   response, registrant = client.registrants(training).create({
+        #     first_name: 'John',
+        #     last_name: 'Doe',
+        #     email: 'john@example.com'
+        #   })
+        #
+        #   if response.ok?
+        #     # Do something with registrant
+        #   end
+        #
+        # Options:
+        #
+        # - `first_name`: First name of user. Required.
+        # - `last_name`: Last name of user. Required.
+        # - `email`: Email of registrant. Required.
+        #
+        # Endpoint: https://developer.citrixonline.com/api/gototraining-rest-api/apimethod/register-training-0
+        #
+        def create(attributes)
+          registrant = Resource::Registrant.new(attributes)
+
+          url = url_for('organizers', credentials.organizer_key, 'trainings', training.key, 'registrants')
+          response = http_client.post(url, registrant.serialize)
+
+          if response.ok?
+            additional_attributes = Serializer::Registrant.new(attributes: response.json).deserialize
+            additional_attributes.each do |key, value|
+              registrant.public_send("#{key}=", value) if value
+            end
+          end
+
+          [response, registrant]
+        end
+
+        # Retrieve details on all registrants for a specific training.
+        #
+        # Registrants can be:
+        #
+        # - UNREGISTERED: registrant withdrew their registration but didn't
+        #   opt-out of receiving more training or webinar information
+        # - DELETED: registrant withdrew their registration and opted-out of
+        #   receiving more information about the training or webinar
+        # - WAITING: registrant registered and is awaiting approval (where
+        #   organizer has required approval)
+        # - APPROVED: registrant registered and is approved
+        # - DENIED - registrant registered and was not approved.
+        #
+        # IMPORTANT: The registrant data caches are typically updated
+        # immediately and the data will be returned in the response. However,
+        # the update can take as long as two hours.
+        #
+        # Endpoint: https://developer.citrixonline.com/api/gototraining-rest-api/apimethod/get-training-registrants-0
+        #
+        def all
+          url = url_for('organizers', credentials.organizer_key, 'trainings', training.key, 'registrants')
+          response = http_client.get(url)
+
+          if response.ok?
+            registrants = response.json.map do |attrs|
+              Resource::Registrant.new Resource::Registrant.deserialize(attrs)
+            end
+          end
+
+          [response, registrants]
+        end
+
+        # This call cancels a registration in a scheduled training for a
+        # specific registrant.
+        #
+        # If the registrant has paid for the training, a cancellation cannot be
+        # completed with this method; it must be completed on the Citrix
+        # external admin site. No notification is sent to the registrant or
+        # the organizer by default. The registrant can re-register if needed.
+        #
+        # Endpoint: https://developer.citrixonline.com/api/gototraining-rest-api/apimethod/cancel-registration-0
+        #
+        def remove(registrant)
+          url = url_for('organizers', credentials.organizer_key, 'trainings', training.key, 'registrants', registrant.key)
+          http_client.delete(url)
+        end
+      end
+    end
+  end
+end