citrix 0.0.0 → 0.1.0

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

@@ -0,0 +1,91 @@
+module Citrix
+  module Training
+    module Namespace
+      class Trainings
+        include Helpers::Initializer
+        include Helpers::HttpClient
+
+        # Set the credentials.
+        attr_accessor :credentials
+
+        # Create a new training.
+        #
+        #   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?
+        #   else
+        #   end
+        #
+        # Options:
+        #
+        # - `name`: Name of the training. Required.
+        # - `description`: Description of the training. Required.
+        # - `timezone`: Time zone of the training. Required.
+        # - `dates`: Array containing instances of `Citrix::Training::TrainingDate`. Required.
+        # - `organizers`: Array containing instances of `Citrix::Training::Organizer`. Optional.
+        # - `web_registration`: Disable/Enable web registration. Optional.
+        # - `confirmation_email`: Disable/Enable confirmation e-mails. Optional.
+        #
+        # Endpoint: https://developer.citrixonline.com/api/gototraining-rest-api/apimethod/create-training-0
+        #
+        def create(attributes)
+          training = Resource::Training.new(attributes)
+
+          url = url_for('organizers', credentials.organizer_key, 'trainings')
+          response = http_client.post(url, training.serialize)
+
+          training.key = json_parser.load(response.body) if response.ok?
+
+          [response, training]
+        end
+
+        # Retrieve information on all scheduled trainings for a given organizer.
+        #
+        # The trainings are returned in the order in which they were created.
+        # Completed trainings are not included; ongoing trainings with past
+        # sessions are included along with the past sessions. If the organizer
+        # does not have any scheduled trainings, the response will be empty.
+        #
+        # Endpoint: https://developer.citrixonline.com/api/gototraining-rest-api/apimethod/get-trainings
+        #
+        def all
+          url = url_for('organizers', credentials.organizer_key, 'trainings')
+          response = http_client.get(url)
+
+          if response.ok?
+            trainings = response.json.map do |attrs|
+              Resource::Training.new Resource::Training.deserialize(attrs)
+            end
+          end
+
+          [response, trainings]
+        end
+
+        # Deletes a scheduled or completed training.
+        #
+        # For scheduled trainings, it deletes all scheduled sessions of the
+        # training. For completed trainings, the sessions remain in the
+        # database. No email is sent to organizers or registrants, but when
+        # participants attempt to start or join the training, they are directed
+        # to a page that states: `Training Not Found: The training you are
+        # trying to join is no longer available.`
+        #
+        #   response = client.trainings.remove(training)
+        #   response.ok? #=> successfully removed
+        #
+        def remove(training)
+          url = url_for('organizers', credentials.organizer_key, 'trainings', training.key)
+          http_client.delete(url)
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/resource/registrant.rb

@@ -0,0 +1,60 @@
+module Citrix
+  module Training
+    module Resource
+      class Registrant
+        include Helpers::Initializer
+
+        # Set the first name of the user.
+        attr_accessor :first_name
+
+        # Set the last name of the user.
+        attr_accessor :last_name
+
+        # Set the e-mail.
+        attr_accessor :email
+
+        # Set the join url.
+        attr_accessor :join_url
+
+        # Set the confirmation url.
+        attr_accessor :confirmation_url
+
+        # Set the registrant key.
+        attr_accessor :key
+
+        # Set the status.
+        attr_accessor :status
+
+        ATTRIBUTES = %i[
+          first_name
+          last_name
+          email
+        ]
+
+        # Convert `attributes` into parameters that
+        # Citrix API can understand.
+        def self.serialize(attributes)
+          Serializer::Registrant.new(attributes: attributes).serialize
+        end
+
+        # Convert `attributes` into parameters that
+        # Citrix::Training::Resource::Registrant can understand.
+        def self.deserialize(attributes)
+          Serializer::Registrant.new(attributes: attributes).deserialize
+        end
+
+        # Return a hash containing all attributes.
+        def attributes
+          ATTRIBUTES.each_with_object({}) do |name, buffer|
+            buffer[name] = public_send(name)
+          end
+        end
+
+        # Serialize the attributes.
+        def serialize
+          self.class.serialize(attributes)
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/resource/training.rb

@@ -0,0 +1,67 @@
+module Citrix
+  module Training
+    module Resource
+      class Training
+        include Helpers::Initializer
+
+        # Set the name of the training.
+        attr_accessor :name
+
+        # Set the description of the training.
+        attr_accessor :description
+
+        # Set the timezone.
+        attr_accessor :timezone
+
+        # Set the dates.
+        attr_accessor :dates
+
+        # Set the organizers.
+        attr_accessor :organizers
+
+        # Set confirmation e-mail delivery.
+        attr_accessor :confirmation_email
+
+        # Set web registration.
+        attr_accessor :web_registration
+
+        # Set the training key.
+        attr_accessor :key
+
+        ATTRIBUTES = %i[
+          name
+          description
+          timezone
+          web_registration
+          confirmation_email
+          organizers
+          dates
+        ]
+
+        # Convert `attributes` into parameters that
+        # Citrix API can understand.
+        def self.serialize(attributes)
+          Serializer::Training.new(attributes: attributes).serialize
+        end
+
+        # Convert `attributes` into parameters that
+        # Citrix::Training::Resource::Training can understand.
+        def self.deserialize(attributes)
+          Serializer::Training.new(attributes: attributes).deserialize
+        end
+
+        # Return a hash containing all attributes.
+        def attributes
+          ATTRIBUTES.each_with_object({}) do |name, buffer|
+            buffer[name] = public_send(name)
+          end
+        end
+
+        # Serialize the attributes.
+        def serialize
+          self.class.serialize(attributes)
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/resource/training_date.rb

@@ -0,0 +1,25 @@
+module Citrix
+  module Training
+    module Resource
+      class TrainingDate
+        # The starting datetime.
+        attr_reader :starts_at
+
+        # The ending datetime.
+        attr_reader :ends_at
+
+        def initialize(starts_at, ends_at)
+          @starts_at = starts_at
+          @ends_at = ends_at
+        end
+
+        def serialize
+          Serializer::TrainingDate.new(attributes: {
+            starts_at: starts_at,
+            ends_at: ends_at
+          }).serialize
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/serializer/registrant.rb

@@ -0,0 +1,32 @@
+module Citrix
+  module Training
+    module Serializer
+      class Registrant
+        include Helpers::Initializer
+
+        # Set attributes that can be (de)serialized.
+        attr_accessor :attributes
+
+        def serialize
+          {
+            givenName: attributes[:first_name],
+            surname: attributes[:last_name],
+            email: attributes[:email]
+          }
+        end
+
+        def deserialize
+          {
+            first_name: attributes['givenName'],
+            last_name: attributes['surname'],
+            email: attributes['email'],
+            join_url: attributes['joinUrl'],
+            confirmation_url: attributes['confirmationUrl'],
+            key: attributes['registrantKey'],
+            status: attributes['status'] ? attributes['status'].downcase : nil
+          }
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/serializer/training.rb

@@ -0,0 +1,49 @@
+module Citrix
+  module Training
+    module Serializer
+      class Training
+        include Helpers::Initializer
+
+        # Set attributes that can be (de)serialized.
+        attr_accessor :attributes
+
+        def serialize
+          {
+            name: attributes[:name],
+            description: attributes[:description],
+            timeZone: attributes[:timezone],
+            times: (attributes[:dates] || []).map(&:serialize),
+            organizers: (attributes[:organizers] || []).map(&:key),
+            registrationSettings: {
+              disableWebRegistration: !attributes.fetch(:web_registration, true),
+              disableConfirmationEmail: !attributes.fetch(:confirmation_email, true),
+            }
+          }
+        end
+
+        def deserialize
+          {
+            key: attributes['trainingKey'],
+            name: attributes['name'],
+            description: attributes['description'],
+            timezone: attributes['timeZone'],
+            dates: deserialize_dates(attributes['times'] || []),
+            web_registration: !attributes['registrationSettings']['disableWebRegistration'],
+            confirmation_email: !attributes['registrationSettings']['disableConfirmationEmail']
+          }
+        end
+
+        private
+
+        def deserialize_dates(dates)
+          dates.map do |date|
+            Resource::TrainingDate.new(
+              Time.parse(date['startDate']),
+              Time.parse(date['endDate'])
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/citrix/training/serializer/training_date.rb

@@ -0,0 +1,19 @@
+module Citrix
+  module Training
+    module Serializer
+      class TrainingDate
+        include Helpers::Initializer
+
+        # Set attributes.
+        attr_accessor :attributes
+
+        def serialize
+          {
+            startDate: attributes[:starts_at].iso8601,
+            endDate: attributes[:ends_at].iso8601
+          }
+        end
+      end
+    end
+  end
+end

data/lib/citrix/version.rb

@@ -1,3 +1,3 @@
 module Citrix
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/spec/citrix/training/client_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Citrix::Training::Client do
+  describe '.build' do
+    it 'returns client' do
+      client = Citrix::Training::Client.build({})
+      expect(client).to be_a(Citrix::Training::Client)
+    end
+
+    it 'sets credentials' do
+      client = Citrix::Training::Client.build({})
+      expect(client.credentials).to be_a(Citrix::Training::Credentials)
+    end
+  end
+
+  describe '#trainings' do
+    it 'returns namespace' do
+      client = Citrix::Training::Client.build({})
+      expect(client.trainings).to be_a(Citrix::Training::Namespace::Trainings)
+    end
+  end
+end

data/spec/citrix/training/credentials_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Citrix::Training::Credentials do
+  describe '#initialize' do
+    subject(:credentials) {
+      Citrix::Training::Credentials.new(
+        oauth_token: 'OAUTH_TOKEN',
+        organizer_key: 'ORGANIZER_KEY',
+        account_key: 'ACCOUNT_KEY'
+      )
+    }
+
+    it { expect(credentials.oauth_token).to eq('OAUTH_TOKEN') }
+    it { expect(credentials.organizer_key).to eq('ORGANIZER_KEY') }
+    it { expect(credentials.account_key).to eq('ACCOUNT_KEY') }
+  end
+
+  describe '.build' do
+    it 'returns new instance' do
+      credentials = Citrix::Training::Credentials.build({})
+      expect(credentials).to be_a(Citrix::Training::Credentials)
+    end
+
+    it 'returns credentials' do
+      credentials = Citrix::Training::Credentials.new
+      new_credentials = Citrix::Training::Credentials.build(credentials)
+
+      expect(new_credentials).to eq(credentials)
+    end
+  end
+end

data/spec/citrix/training/helpers/http_client_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Citrix::Training::Helpers::HttpClient do
+  let(:helper) { Object.new.extend(described_class) }
+
+  describe '#json_parser' do
+    it 'returns parser' do
+      expect(helper.json_parser).to eq(helper.http_client.configuration.json_parser)
+    end
+  end
+
+  describe '#url_for' do
+    it 'returns url' do
+      url = helper.url_for('trainings', 1234)
+      expect(url).to eq(File.join(Citrix::Training::API_ENDPOINT, 'trainings', '1234'))
+    end
+  end
+
+  describe '#http_client' do
+    let(:config) { helper.http_client.configuration }
+
+    it 'enabled debug mode' do
+      $DEBUG = true
+      expect(config.logger).to be_a(Logger)
+    end
+
+    it 'skips debug mode' do
+      $DEBUG = false
+      expect(config.logger).to be_falsy
+    end
+
+    it 'sets user agent' do
+      expect(config.user_agent).to eq("Citrix::Rubygems/#{Citrix::VERSION}")
+    end
+
+    context 'default headers' do
+      it 'sets content type' do
+        expect(config.default_headers['Content-Type']).to eq('application/json')
+      end
+
+      it 'sets accept' do
+        expect(config.default_headers['Accept']).to eq('application/json')
+      end
+
+      it 'sets authorization' do
+        credentials = double(oauth_token: 'OAUTH_TOKEN')
+        allow(helper).to receive(:credentials).and_return(credentials)
+        auth_header = config.default_headers['Authorization'].call
+
+        expect(auth_header).to eq('OAuth oauth_token=OAUTH_TOKEN')
+      end
+    end
+  end
+end