domoscio_admin 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a790c17d0b0a88271416a5f4a7fa5f2a06e4bb5b0a751b9d1e91483bc006d864
-  data.tar.gz: bbd25ad9fb705fbea08d2e6099355c31e39c6cece6b3c07d0673d75f6887a422
+  metadata.gz: 9b05bb26fa031c8583ae9251bde136530c0d17f4da1263ab37d0fe40838fb6c0
+  data.tar.gz: ba80e651fb29852d63120262a8677970314ae6461da2bb9b0bd6b9a1bedda7ca
 SHA512:
-  metadata.gz: a7f80348978cb8817f9b4bdbea72d96108226bd76090a2cf5181054f364ce010f1ef6fcc8e55c15f3c2f0601fd152e2717f8c674a7480abca0cb75e8296b3eee
-  data.tar.gz: edf7e8648248865b3e5a96aa704f896ceb786b073aa906b507b7b92f0ab1a1a1d8124264a0bc537aedaa6804aa01af3a8f331fd85ca7abd2da0bacb91822b28b
+  metadata.gz: ebeae80ae1e4d863a3ca56e69d21255140ef43f4f0d0dc6dc93ff9145911e8def43a85852a5b541497c794329b9f2d77dc3b1cdf70fae5692163f4b1873a5098
+  data.tar.gz: 2bd5e27b58558110177d1e50a232189237b148bdccdbb2ce23bedc7040c643be8fad85992c67f73e612c7c373582b028b624d8d24c4a19ebf5d7f1e981799869

data/lib/domoscio_admin/authorization_token.rb

@@ -1,54 +1,53 @@
 module DomoscioAdmin
   module AuthorizationToken
+    # Token Manager
     class Manager
       class << self
         def storage
-          @@storage ||= FileStorage.new
+          @storage ||= DomoscioAdmin.configuration.file_storage ? FileStorage.new : ManualSetting.new
         end
 
-        def storage=(storage)
-          @@storage = storage
-        end
-
-        def get_token
+        def token
           storage.get
         end
       end
     end
 
-    class StaticStorage
+    # Manages tokens with configuration
+    class ManualSetting
       def get
-        @@token ||= nil
+        {
+          access_token: DomoscioAdmin.configuration.access_token,
+          refresh_token: DomoscioAdmin.configuration.refresh_token
+        }
       end
 
       def store(token)
-        @@token = token
+        DomoscioAdmin.configuration.access_token = token[:access_token]
+        DomoscioAdmin.configuration.refresh_token = token[:refresh_token]
       end
     end
 
+    # Manages tokens with local File
     class FileStorage
       require 'yaml'
-      @temp_dir
 
-      def initialize(temp_dir = nil)
-        @temp_dir = temp_dir || DomoscioAdmin.configuration.temp_dir
-        raise "Path to temporary folder is not defined" unless @temp_dir
+      def initialize
+        raise 'Path to temporary folder is not defined' unless DomoscioAdmin.configuration.temp_dir
       end
 
       def get
-        begin
-          f = File.open(file_path, File::RDONLY)
-          f.flock(File::LOCK_SH)
-          txt = f.read
-          f.close
-          YAML.load(txt) || nil
-        rescue Errno::ENOENT
-          nil
-        end
+        f = File.open(file_path, File::RDONLY)
+        f.flock(File::LOCK_SH)
+        txt = f.read
+        f.close
+        YAML.safe_load(txt) || nil
+      rescue Errno::ENOENT
+        nil
       end
 
       def store(token)
-        File.open(file_path, File::RDWR | File::CREAT, 0644) do |f|
+        File.open(file_path, File::RDWR|File::CREAT, 0o644) do |f|
           f.flock(File::LOCK_EX)
           f.truncate(0)
           f.rewind
@@ -57,7 +56,7 @@ module DomoscioAdmin
       end
 
       def file_path
-        File.join(@temp_dir, "DomoscioAdmin.AuthorizationToken.FileStore.tmp")
+        File.join(DomoscioAdmin.configuration.temp_dir, 'DomoscioAdmin.AuthorizationToken.FileStore.tmp')
       end
     end
   end

data/lib/domoscio_admin/errors.rb

@@ -1,20 +1,24 @@
 module DomoscioAdmin
   # Generic error superclass for MangoPay specific errors.
-  # Currently never instantiated directly.
-  # Currently only single subclass used.
   class Error < StandardError
   end
 
-  # ResponseError from DomoscioAdmin
+  # Error Message from DomoAdmin
   class ResponseError < Error
     attr_reader :request_url, :code, :details, :body, :request_params
 
     def initialize(request_url, code, details = {}, body = nil, request_params = {})
-      @request_url, @code, @details, @body, @request_params = request_url, code, details, body, request_params
+      @request_url = request_url
+      @code = code
+      @details = details
+      @body = body
+      @request_params = request_params
       super(message) if message
     end
 
-    def message; @details.is_a?(Hash) ? @details.dig(:error, :message) : @details; end
+    def message
+      @details.is_a?(Hash) && @details[:error].is_a?(Hash) ? @details.dig(:error, :message) : @details
+    end
   end
 
   # ProcessingError from DomoscioAdmin
@@ -22,10 +26,16 @@ module DomoscioAdmin
     attr_reader :request_url, :code, :details, :body, :request_params
 
     def initialize(request_url, code, details = {}, body = nil, request_params = {})
-      @request_url, @code, @details, @body, @request_params = request_url, code, details, body, request_params
+      @request_url = request_url
+      @code = code
+      @details = details
+      @body = body
+      @request_params = request_params
       super(message) if message
     end
 
-    def message; @details.message; end
+    def message
+      @details.message
+    end
   end
 end

data/lib/domoscio_admin/{instance → resources/instances}/instance_parameter.rb

@@ -1,5 +1,5 @@
 module DomoscioAdmin
-  class InstanceParameter < Resource
+  class InstanceParameter < ResourceInstance
     include DomoscioAdmin::HTTPCalls::Fetch
     include DomoscioAdmin::HTTPCalls::Update
   end

data/lib/domoscio_admin/resources/instances/instance_user.rb

@@ -0,0 +1,8 @@
+module DomoscioAdmin
+  class InstanceUser < ResourceInstance
+    include DomoscioAdmin::HTTPCalls::Create
+    include DomoscioAdmin::HTTPCalls::Fetch
+    include DomoscioAdmin::HTTPCalls::Update
+    include DomoscioAdmin::HTTPCalls::Destroy
+  end
+end

data/lib/domoscio_admin/resources/instances/student_group.rb

@@ -0,0 +1,8 @@
+module DomoscioAdmin
+    class StudentGroup < ResourceInstance
+      include DomoscioAdmin::HTTPCalls::Create
+      include DomoscioAdmin::HTTPCalls::Fetch
+      include DomoscioAdmin::HTTPCalls::Update
+      include DomoscioAdmin::HTTPCalls::Destroy
+    end
+end

data/lib/domoscio_admin/resources/resource.rb

@@ -0,0 +1,9 @@
+module DomoscioAdmin
+  class Resource
+    class << self
+      def class_name
+        name.split('::')[-1]
+      end
+    end
+  end
+end

data/lib/domoscio_admin/resources/resource_instance.rb

@@ -0,0 +1,21 @@
+module DomoscioAdmin
+  class ResourceInstance < Resource
+    class << self
+      def url(id = nil)
+        raise NotImplementedError, 'Resource is an abstract class. Do not use it directly.' if self == Resource
+
+        build_url = "/instances/#{DomoscioAdmin.configuration.client_id}/#{underscore(class_name)}s"
+        build_url << "/#{CGI.escape(id.to_s)}" if id
+        build_url
+      end
+
+      def underscore(string)
+        string.gsub(/::/, '/')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr('-', '_')
+              .downcase
+      end
+    end
+  end
+end

data/lib/domoscio_admin/{resource.rb → resources/resource_user.rb}

@@ -1,16 +1,12 @@
 module DomoscioAdmin
-  class Resource
+  class ResourceUser < Resource
     class << self
-      def class_name
-        name.split('::')[-1]
-      end
-
       def url(id = nil)
         if self == Resource
           raise NotImplementedError.new('Resource is an abstract class. Do not use it directly.')
         end
 
-        build_url = "/instances/#{DomoscioAdmin.configuration.client_id}/#{class_name.underscore}s"
+        build_url = "/users"
         build_url << "/#{CGI.escape(id.to_s)}" if id
         return build_url
       end

data/lib/domoscio_admin/resources/users/user.rb

@@ -0,0 +1,5 @@
+module DomoscioAdmin
+  class User < ResourceUser
+    include DomoscioAdmin::HTTPCalls::Fetch
+  end
+end

data/lib/domoscio_admin/version.rb

@@ -1,3 +1,3 @@
 module DomoscioAdmin
-  VERSION = "0.1.0"
+  VERSION = '0.3.3'.freeze
 end

data/lib/domoscio_admin.rb

@@ -1,24 +1,27 @@
 require 'net/https'
 require 'cgi/util'
 require 'multi_json'
-# helpers
 require 'domoscio_admin/version'
 require 'domoscio_admin/json'
 require 'domoscio_admin/errors'
 require 'domoscio_admin/authorization_token'
-# generators
-require 'domoscio_admin/generators/install_generator'
-# resources
 require 'domoscio_admin/http_calls'
-require 'domoscio_admin/resource'
-require 'domoscio_admin/instance/instance_parameter'
+require 'domoscio_admin/resources/resource'
+require 'domoscio_admin/resources/resource_user'
+require 'domoscio_admin/resources/resource_instance'
+require 'domoscio_admin/resources/instances/instance_parameter'
+require 'domoscio_admin/resources/instances/instance_user'
+require 'domoscio_admin/resources/instances/student_group'
+require 'domoscio_admin/resources/users/user'
 
 module DomoscioAdmin
   class Configuration
-    attr_accessor :root_url, :client_id, :client_passphrase, :temp_dir
+    attr_accessor :client_id, :client_passphrase, :temp_dir, :root_url,
+                  :file_storage, :access_token, :refresh_token
 
-    def root_url
-      @root_url ||= ""
+    def initialize
+      @root_url = ''
+      @file_storage ||= true
     end
   end
 
@@ -51,45 +54,48 @@ module DomoscioAdmin
     uri = api_uri(url)
 
     response = DomoscioAdmin.send_request(uri, method, params, headers)
-    return response if response.kind_of? DomoscioAdmin::ProcessingError
+    return response if response.is_a? DomoscioAdmin::ProcessingError
 
     begin
       raise_http_failure(uri, response, params)
       data = DomoscioAdmin::JSON.load(response.body.nil? ? '' : response.body)
-      DomoscioAdmin::AuthorizationToken::Manager.storage.store({ access_token: response['Accesstoken'], refresh_token: response['Refreshtoken'] }) if store_tokens
-    rescue MultiJson::LoadError => exception
-      data = ProcessingError.new(uri, 500, exception, response.body, params)
-    rescue ResponseError => exception
-      data = exception
+      if store_tokens
+        DomoscioAdmin::AuthorizationToken::Manager.storage.store({
+                                                                   access_token: response['Accesstoken'],
+                                                                   refresh_token: response['Refreshtoken']
+                                                                 })
+      end
+    rescue MultiJson::LoadError => e
+      data = ProcessingError.new(uri, 500, e, response.body, params)
+    rescue ResponseError => e
+      data = e
     end
 
     data
   end
 
-  private
-
   # This function catches usual Http errors during calls
   #
   def self.send_request(uri, method, params, headers)
-    begin
-      response = perform_call(uri, method, params, headers)
-      response = retry_call_and_store_tokens(uri, method, params, headers) if ['401', '403'].include? response.code
-      response
-    rescue Timeout::Error, Errno::EINVAL, HTTP::ConnectionError, Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => exception
-      ProcessingError.new(uri, 500, exception, response, params)
-    end
+    response = perform_call(uri, method, params, headers)
+    response = retry_call_and_store_tokens(uri, method, params) if %w[401 403].include? response.code
+    response
+  rescue Timeout::Error, Errno::EINVAL, Errno::ECONNREFUSED, Errno::ECONNRESET,
+         EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+    ProcessingError.new(uri, 500, e, response, params)
   end
 
   # This helper will check the response status and build the correcponding DomoscioAdmin::ResponseError
   #
   def self.raise_http_failure(uri, response, params)
-    unless response.kind_of? Net::HTTPSuccess
-      if response.blank?
-        raise ResponseError.new(uri, 500, { error: { status: 500, message: 'DomoscioAdmin not available' } }, {}, params)
-      else
-        raise ResponseError.new(uri, response.code.to_i, DomoscioAdmin::JSON.load((response.body.nil? ? '' : response.body), :symbolize_keys => true), response.body, params)
-      end
-    end
+    return if response.is_a? Net::HTTPSuccess
+
+    raise ResponseError.new(
+      uri,
+      response.code.to_i,
+      DomoscioAdmin::JSON.load((response.body.nil? ? '' : response.body), symbolize_keys: true),
+      response.body, params
+    )
   end
 
   # Actual HTTP call is performed here
@@ -104,26 +110,29 @@ module DomoscioAdmin
 
   # This method is called when AdaptiveEngine returns tokens errors
   # Action on those errors is to retry and request new tokens, those new token are then stored
-  def self.retry_call_and_store_tokens(uri, method, params, headers)
+  def self.retry_call_and_store_tokens(uri, method, params)
     headers = request_new_tokens
     response = perform_call(uri, method, params, headers)
-    DomoscioAdmin::AuthorizationToken::Manager.storage.store({ access_token: response['Accesstoken'], refresh_token: response['Refreshtoken'] })
+    DomoscioAdmin::AuthorizationToken::Manager.storage.store({
+                                                               access_token: response['Accesstoken'],
+                                                               refresh_token: response['Refreshtoken']
+                                                             })
     response
   end
 
   def self.user_agent
-    @uname ||= get_uname
+    @uname ||= uname
     {
       bindings_version: DomoscioAdmin::VERSION,
       lang: 'ruby',
       lang_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
       platform: RUBY_PLATFORM,
       uname: @uname
-    }
+    }.to_s
   end
 
-  def self.get_uname
-    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+  def self.uname
+    `uname -a 2>/dev/null` if RUBY_PLATFORM =~ /linux|darwin/i
   rescue Errno::ENOMEM
     'uname lookup failed'
   end
@@ -148,10 +157,10 @@ module DomoscioAdmin
   #
   def self.send_current_tokens(auth_token)
     {
-      'user_agent' => "#{DomoscioAdmin.user_agent}",
-      'ClientId' => "#{DomoscioAdmin.configuration.client_id}",
-      'AccessToken' => "#{auth_token[:access_token]}",
-      'RefreshToken' => "#{auth_token[:refresh_token]}",
+      'user_agent' => DomoscioAdmin.user_agent,
+      'ClientId' => DomoscioAdmin.configuration.client_id,
+      'AccessToken' => auth_token[:access_token],
+      'RefreshToken' => auth_token[:refresh_token],
       'Content-Type' => 'application/json'
     }
   end
@@ -159,17 +168,10 @@ module DomoscioAdmin
   # If we cant find tokens of they are corrupted / expired, then we set headers to request new ones
   def self.request_new_tokens
     {
-      'user_agent' => "#{DomoscioAdmin.user_agent}",
-      'ClientId' => "#{DomoscioAdmin.configuration.client_id}",
+      'user_agent' => DomoscioAdmin.user_agent,
+      'ClientId' => DomoscioAdmin.configuration.client_id,
       'Authorization' => "Token token=#{DomoscioAdmin.configuration.client_passphrase}",
       'Content-Type' => 'application/json'
     }
   end
-
-  DomoscioAdmin.configure do |c|
-    c.client_id = nil
-    c.client_passphrase = nil
-    c.temp_dir = File.expand_path('../tmp', __FILE__)
-    FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
-  end
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_admin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Pascal Lim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Ruby client to interact with Domoscio Admin.
 email:
 - pascal.lim@domoscio.com
@@ -37,19 +51,22 @@ files:
 - lib/domoscio_admin.rb
 - lib/domoscio_admin/authorization_token.rb
 - lib/domoscio_admin/errors.rb
-- lib/domoscio_admin/generators/install_generator.rb
-- lib/domoscio_admin/generators/templates/install.rb
 - lib/domoscio_admin/http_calls.rb
-- lib/domoscio_admin/instance/instance_parameter.rb
 - lib/domoscio_admin/json.rb
-- lib/domoscio_admin/resource.rb
+- lib/domoscio_admin/resources/instances/instance_parameter.rb
+- lib/domoscio_admin/resources/instances/instance_user.rb
+- lib/domoscio_admin/resources/instances/student_group.rb
+- lib/domoscio_admin/resources/resource.rb
+- lib/domoscio_admin/resources/resource_instance.rb
+- lib/domoscio_admin/resources/resource_user.rb
+- lib/domoscio_admin/resources/users/user.rb
 - lib/domoscio_admin/version.rb
 - spec/spec_helper.rb
 homepage: https://www.domoscio.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -57,15 +74,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Summary of DomoscioAdmin.
 test_files:

data/lib/domoscio_admin/generators/install_generator.rb

@@ -1,10 +0,0 @@
-require 'rails/generators'
-module DomoscioAdmin
-  class InstallGenerator < ::Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    desc "Generate config file for DomoscioAdmin configuration"
-    def install
-      copy_file "install.rb", "config/initializers/domoscio_admin.rb"
-    end
-  end
-end

data/lib/domoscio_admin/generators/templates/install.rb

@@ -1,6 +0,0 @@
-DomoscioAdmin.configure do |c|
-  c.client_id = ENV['DOMOSCIO_ID']
-  c.client_passphrase = ENV['DOMOSCIO_PASSWORD']
-  c.temp_dir = File.expand_path('../tmp', __FILE__)
-  FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
-end