domoscio_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a790c17d0b0a88271416a5f4a7fa5f2a06e4bb5b0a751b9d1e91483bc006d864
+  data.tar.gz: bbd25ad9fb705fbea08d2e6099355c31e39c6cece6b3c07d0673d75f6887a422
+SHA512:
+  metadata.gz: a7f80348978cb8817f9b4bdbea72d96108226bd76090a2cf5181054f364ce010f1ef6fcc8e55c15f3c2f0601fd152e2717f8c674a7480abca0cb75e8296b3eee
+  data.tar.gz: edf7e8648248865b3e5a96aa704f896ceb786b073aa906b507b7b92f0ab1a1a1d8124264a0bc537aedaa6804aa01af3a8f331fd85ca7abd2da0bacb91822b28b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,69 @@
+# DomoscioAdmin
+
+This README would document whatever steps are necessary to get the DomoscioAdmin Ruby SDK up and running.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+DomoscioAdmin works with Rails 3.2 onwards.
+
+### Installing
+
+Add it to your Gemfile with:
+
+```ruby
+gem 'domoscio_admin', '0.1.0', git: 'git://github.com/Celumproject/domoscio-admin-sdk-ruby', branch: 'master'
+```
+
+Then run `bundle install`
+
+Next, you need to run the generator:
+
+```console
+$ rails generate domoscio_admin:install
+```
+
+Then you have to configure the `ENV['DOMOSCIO_ID']` and `ENV['DOMOSCIO_PASSWORD']` with your credentials to access your enabled APIs. Refer to the API documentation for details:
+https://domoscio.com/wiki/doku.php?id=api2:start
+
+```ruby
+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
+```
+
+| Key  | Type | Description |
+| ------------- | ------------- | ------------- |
+| client_id  | `integer` | this is your instance_id, required for access to your data |
+| client_passphrase  | `string` | client_passphrase is your secret key, this token is paired with your client_id |
+
+## Basic DomoscioAdmin use
+
+### Get Url
+
+Server request need 2 parameters :  
+    - First argument is the client_id.  
+    - Second argument is the request body.  
+
+In `your controller`:
+
+```ruby
+@chart_url = DomoscioAdmin::InstanceParam.update(client_id, {param_1: "param_value"})
+```
+
+
+## Versioning
+
+Currently v0.2.0
+
+## Authors
+
+See the list of contributors (https://github.com/Celumproject/domoscio_js/contributors)
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DomoscioAdmin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/domoscio_admin/authorization_token.rb

@@ -0,0 +1,64 @@
+module DomoscioAdmin
+  module AuthorizationToken
+    class Manager
+      class << self
+        def storage
+          @@storage ||= FileStorage.new
+        end
+
+        def storage=(storage)
+          @@storage = storage
+        end
+
+        def get_token
+          storage.get
+        end
+      end
+    end
+
+    class StaticStorage
+      def get
+        @@token ||= nil
+      end
+
+      def store(token)
+        @@token = token
+      end
+    end
+
+    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
+      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
+      end
+
+      def store(token)
+        File.open(file_path, File::RDWR | File::CREAT, 0644) do |f|
+          f.flock(File::LOCK_EX)
+          f.truncate(0)
+          f.rewind
+          f.puts(YAML.dump(token))
+        end
+      end
+
+      def file_path
+        File.join(@temp_dir, "DomoscioAdmin.AuthorizationToken.FileStore.tmp")
+      end
+    end
+  end
+end

data/lib/domoscio_admin/errors.rb

@@ -0,0 +1,31 @@
+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
+  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
+      super(message) if message
+    end
+
+    def message; @details.is_a?(Hash) ? @details.dig(:error, :message) : @details; end
+  end
+
+  # ProcessingError from DomoscioAdmin
+  class ProcessingError < 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
+      super(message) if message
+    end
+
+    def message; @details.message; end
+  end
+end

data/lib/domoscio_admin/generators/install_generator.rb

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

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

data/lib/domoscio_admin/http_calls.rb

@@ -0,0 +1,52 @@
+module DomoscioAdmin
+  module HTTPCalls
+    module Create
+      module ClassMethods
+        def create(*id, params)
+          id = id.empty? ? nil : id[0]
+          DomoscioAdmin.request(:post, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Update
+      module ClassMethods
+        def update(id = nil, params = {})
+          DomoscioAdmin.request(:put, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Fetch
+      module ClassMethods
+        def fetch(id = nil, params = {})
+          DomoscioAdmin.request(:get, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Destroy
+      module ClassMethods
+        def destroy(id = nil, params = {})
+          DomoscioAdmin.request(:delete, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/domoscio_admin/instance/instance_parameter.rb

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

data/lib/domoscio_admin/json.rb

@@ -0,0 +1,23 @@
+module DomoscioAdmin
+  module JSON
+    class << self
+      if MultiJson.respond_to?(:dump)
+        def dump(*args)
+          MultiJson.dump(*args)
+        end
+
+        def load(*args)
+          MultiJson.load(*args)
+        end
+      else
+        def dump(*args)
+          MultiJson.encode(*args)
+        end
+
+        def load(*args)
+          MultiJson.decode(*args)
+        end
+      end
+    end
+  end
+end

data/lib/domoscio_admin/resource.rb

@@ -0,0 +1,19 @@
+module DomoscioAdmin
+  class 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 << "/#{CGI.escape(id.to_s)}" if id
+        return build_url
+      end
+    end
+  end
+end

data/lib/domoscio_admin/version.rb

@@ -0,0 +1,3 @@
+module DomoscioAdmin
+  VERSION = "0.1.0"
+end

data/lib/domoscio_admin.rb

@@ -0,0 +1,175 @@
+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'
+
+module DomoscioAdmin
+  class Configuration
+    attr_accessor :root_url, :client_id, :client_passphrase, :temp_dir
+
+    def root_url
+      @root_url ||= ""
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  def self.api_uri(url = '')
+    URI(configuration.root_url + url)
+  end
+
+  #
+  # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
+  # - +url+: the part after Configuration#root_url
+  # - +params+: hash; entity data for creation, update etc.; will dump it by JSON and assign to Net::HTTPRequest#body
+  #
+  # Performs HTTP requests to Adaptive Engine
+  # On token issues, will try once to get a new token then will output a DomoscioAdmin::ReponseError with details
+  #
+  # Raises DomoscioAdmin::ResponseError on Adaptive Error Status
+  # Raises DomoscioAdmin::ProcessingError on Internal Error
+  #
+  def self.request(method, url, params = {})
+    store_tokens, headers = request_headers
+    uri = api_uri(url)
+
+    response = DomoscioAdmin.send_request(uri, method, params, headers)
+    return response if response.kind_of? 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
+    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
+  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
+  end
+
+  # Actual HTTP call is performed here
+  #
+  def self.perform_call(uri, method, params, headers)
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
+      req.body = DomoscioAdmin::JSON.dump(params)
+      http.request req
+    end
+  end
+
+  # 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)
+    headers = request_new_tokens
+    response = perform_call(uri, method, params, headers)
+    DomoscioAdmin::AuthorizationToken::Manager.storage.store({ access_token: response['Accesstoken'], refresh_token: response['Refreshtoken'] })
+    response
+  end
+
+  def self.user_agent
+    @uname ||= get_uname
+    {
+      bindings_version: DomoscioAdmin::VERSION,
+      lang: 'ruby',
+      lang_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+      platform: RUBY_PLATFORM,
+      uname: @uname
+    }
+  end
+
+  def self.get_uname
+    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+  rescue Errno::ENOMEM
+    'uname lookup failed'
+  end
+
+  # Process the token loading and analyze
+  # will return the processed headers and a token store flag
+  #
+  def self.request_headers
+    begin
+      auth_token = DomoscioAdmin::AuthorizationToken::Manager.get_token
+      if auth_token && auth_token[:access_token] && auth_token[:refresh_token]
+        [false, send_current_tokens(auth_token)]
+      else
+        [true, request_new_tokens]
+      end
+    rescue SyntaxError, StandardError
+      [true, request_new_tokens]
+    end
+  end
+
+  # If stored token successfully loaded we build the header with them
+  #
+  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]}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  # 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}",
+      '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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# require_relative '../lib/domoscio_admin'
+# require_relative './lib/domoscio_admin/shared_resources'
+
+require 'capybara/rspec'
+require 'capybara-webkit'
+require 'fileutils'
+require 'active_support/all'
+
+Capybara.default_driver = :webkit
+
+def reset_domoscio_admin_configuration
+  DomoscioAdmin.configure do |c|
+    c.client_id = 14
+    c.client_passphrase = '748add958564718f6d7add299655f95c'
+    c.temp_dir = File.expand_path('../tmp', __FILE__)
+    FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
+  end
+end
+reset_domoscio_admin_configuration

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: domoscio_admin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pascal Lim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Ruby client to interact with Domoscio Admin.
+email:
+- pascal.lim@domoscio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/version.rb
+- spec/spec_helper.rb
+homepage: https://www.domoscio.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Summary of DomoscioAdmin.
+test_files:
+- spec/spec_helper.rb