domoscio_rails_local 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f6318acf62febe79287ac1993cce761558f772a
+  data.tar.gz: b8e1579ad39be7fea004f1c4578cb4e16b561332
+SHA512:
+  metadata.gz: 3d7d80802aed9e22229cdf46cff84932995ad0d23afa375107fb8cb27168c24e6617c4231f429df5352b48666a2c0483d45af7ab87876841798a653f6a0503f6
+  data.tar.gz: c5e89cc49d588353e8c19a5b4d805f35572a9bec2c284a4f1905235a52c0a629ba2ad6f6dbe53579d0a7526de6ab30cff8c9e8d23adce0b3d79a9519d545ecd5

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.rdoc

@@ -0,0 +1,3 @@
+= DomoscioRails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'DomoscioRails'
+  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_rails.rb

@@ -0,0 +1,136 @@
+  
+require 'net/http'
+require 'cgi/util'
+require 'multi_json'
+
+# helpers
+require 'domoscio_rails/version'
+require 'domoscio_rails/json'
+require 'domoscio_rails/errors'
+require 'domoscio_rails/authorization_token'
+
+# resources
+require 'domoscio_rails/http_calls'
+require 'domoscio_rails/resource'
+require 'domoscio_rails/admin/user'
+require 'domoscio_rails/student/student'
+require 'domoscio_rails/knowledge/knowledge_graph'
+require 'domoscio_rails/knowledge/knowledge_edge'
+require 'domoscio_rails/knowledge/knowledge_node'
+require 'domoscio_rails/data/knowledge_node_student'
+require 'domoscio_rails/data/result'
+
+
+module DomoscioRails
+
+  class Configuration
+    attr_accessor :preproduction, :root_url,
+    :client_id, :client_passphrase,
+    :temp_dir
+
+    def preproduction
+      @preproduction || false
+    end
+
+    def root_url
+      @root_url || (@preproduction == true  ? "http://localhost:3000" : "")
+    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
+  # - +filters+: hash; pagination params etc.; will encode it by URI and assign to URI#query
+  # - +headers+: hash; request_headers by default
+  # - +before_request_proc+: optional proc; will call it passing the Net::HTTPRequest instance just before Net::HTTPRequest#request
+  #
+  # Raises DomoscioRails::ResponseError if response code != 200.
+  #
+  def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
+    uri = api_uri(url)
+    uri.query = URI.encode_www_form(filters) unless filters.empty?
+    
+    res = Net::HTTP.start(uri.host, uri.port) do |http| # , use_ssl: uri.scheme == 'https') do |http|
+      req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
+      req.body = DomoscioRails::JSON.dump(params)
+      before_request_proc.call(req) if before_request_proc
+      http.request req
+    end
+
+    # decode json data
+    begin
+      data = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
+    rescue MultiJson::LoadError
+      data = {}
+    end
+
+    ############### TEMP!!!! #######################################################
+    #pp method, uri.request_uri, params #, filters, headers
+    #pp res, data
+    #puts
+
+    # if (!(res.is_a? Net::HTTPOK))
+    #   ex = DomoscioRails::ResponseError.new(uri, res.code, data)
+    #   ############## TEMP!!!! ########################################################
+    #   #pp ex, data
+    #   raise ex
+    # end
+
+    # copy pagination info if any
+    # ['x-number-of-pages', 'x-number-of-items'].each { |k|
+#       filters[k.gsub('x-number-of-', 'total_')] = res[k].to_i if res[k]
+#     }
+
+    data
+  end
+
+  private
+
+  def self.user_agent
+    @uname ||= get_uname
+
+    {
+      bindings_version: DomoscioRails::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
+
+  def self.request_headers
+    auth_token = DomoscioRails::AuthorizationToken::Manager.get_token
+    headers = {
+      'user_agent' => "DomoscioRails V2 RubyBindings/#{DomoscioRails::VERSION}",
+      'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",#"#{auth_token['token_type']} #{auth_token['access_token']}",
+      'Content-Type' => 'application/json'
+    }
+    # begin
+#       headers.update('x_mangopay_client_user_agent' => DomoscioRails::JSON.dump(user_agent))
+#     rescue => e
+#       headers.update('x_mangopay_client_raw_user_agent' => user_agent.inspect, error: "#{e} (#{e.class})")
+#     end
+  end
+  
+  
+end

data/lib/domoscio_rails/admin/company.rb

@@ -0,0 +1,7 @@
+module DomoscioRails
+  # A company.
+  class Company < Resource
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+  end
+end

data/lib/domoscio_rails/admin/user.rb

@@ -0,0 +1,10 @@
+module DomoscioRails
+  # A user of the API.
+  class User < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+
+  end
+end

data/lib/domoscio_rails/authorization_token.rb

@@ -0,0 +1,79 @@
+module DomoscioRails
+  module AuthorizationToken
+
+    class Manager
+
+      class << self
+        def storage
+          @@storage ||= StaticStorage.new
+        end
+
+        def storage= (storage)
+          @@storage = storage
+        end
+
+        def get_token
+          # token = storage.get
+          #           if token.nil? || token['timestamp'].nil? || token['timestamp'] <= Time.now
+          #             token = DomoscioRails.request(:post, '/api/oauth/token', {}, {}, {}, Proc.new do |req|
+          #               cfg = DomoscioRails.configuration
+          #               req.basic_auth cfg.client_id, cfg.client_passphrase
+          #               req.body = 'grant_type=client_credentials'
+          #             end)
+          #             token['timestamp'] = Time.now + token['expires_in'].to_i
+          #             storage.store token
+          #           end
+          token = DomoscioRails.configuration.client_passphrase
+          token
+        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 || DomoscioRails.configuration.temp_dir
+        if !@temp_dir
+          raise "Path to temporary folder is not defined"
+        end
+      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, "DomoscioRails.AuthorizationToken.FileStore.tmp")
+      end
+    end
+  end
+end

data/lib/domoscio_rails/data/knowledge_node_student.rb

@@ -0,0 +1,10 @@
+module DomoscioRails
+  # A Knowledge Edge.
+  class KnowledgeNodeStudent < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Destroy
+
+  end
+end

data/lib/domoscio_rails/data/result.rb

@@ -0,0 +1,10 @@
+module DomoscioRails
+  # A Student Result on a KnowledgeNode.
+  class Result < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Destroy
+
+  end
+end

data/lib/domoscio_rails/errors.rb

@@ -0,0 +1,24 @@
+module DomoscioRails
+
+  # Generic error superclass for MangoPay specific errors.
+  # Currently never instantiated directly.
+  # Currently only single subclass used.
+  class Error < StandardError
+  end
+
+  # Thrown from any MangoPay API call whenever
+  # it returns response with HTTP code != 200.
+  class ResponseError < Error
+
+    attr_reader :request_url, :code, :details
+
+    def initialize(request_url, code, details)
+      @request_url, @code, @details = request_url, code, details
+      super(message) if message
+    end
+
+    def message; @details['Message']; end
+    def type;    @details['Type']; end
+    def errors;  @details['errors']; end
+  end
+end

data/lib/domoscio_rails/http_calls.rb

@@ -0,0 +1,59 @@
+module DomoscioRails
+  module HTTPCalls
+    
+    module Create
+      module ClassMethods
+        def create(*id, params)
+          id = id.empty? ? nil : id[0]
+          DomoscioRails.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 = {})
+          DomoscioRails.request(:put, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Fetch
+      module ClassMethods
+        def fetch(id_or_filters = nil)
+          id, filters = DomoscioRails::HTTPCalls::Fetch.parse_id_or_filters(id_or_filters)
+          response = DomoscioRails.request(:get, url(id), {}, filters)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def self.parse_id_or_filters(id_or_filters = nil)
+        id_or_filters.is_a?(Hash) ? [nil, id_or_filters] : [id_or_filters, {}]
+      end
+    end
+    
+    module Destroy
+      module ClassMethods
+        def destroy(id = nil, params = {})
+          DomoscioRails.request(:delete, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end      
+    end
+    
+  end
+end

data/lib/domoscio_rails/json.rb

@@ -0,0 +1,23 @@
+module DomoscioRails
+  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_rails/knowledge/knowledge_edge.rb

@@ -0,0 +1,11 @@
+module DomoscioRails
+  # A Knowledge Edge.
+  class KnowledgeEdge < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+    include DomoscioRails::HTTPCalls::Destroy
+
+  end
+end

data/lib/domoscio_rails/knowledge/knowledge_graph.rb

@@ -0,0 +1,11 @@
+module DomoscioRails
+  # A Knowledge Graph.
+  class KnowledgeGraph < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+    include DomoscioRails::HTTPCalls::Destroy
+
+  end
+end

data/lib/domoscio_rails/knowledge/knowledge_node.rb

@@ -0,0 +1,11 @@
+module DomoscioRails
+  # A Knowledge Node.
+  class KnowledgeNode < Resource
+    
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+    include DomoscioRails::HTTPCalls::Destroy
+
+  end
+end

data/lib/domoscio_rails/resource.rb

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

data/lib/domoscio_rails/student/student.rb

@@ -0,0 +1,9 @@
+module DomoscioRails
+  # A company.
+  class Student < Resource
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Update
+    include DomoscioRails::HTTPCalls::Destroy
+  end
+end

data/lib/domoscio_rails/version.rb

@@ -0,0 +1,3 @@
+module DomoscioRails
+  VERSION = "0.0.1"
+end

data/lib/tasks/domoscio_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :domoscio_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: domoscio_rails_local
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benoit Praly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 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: Description of DomoscioRails.
+email:
+- benoit.praly@domoscio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/domoscio_rails.rb
+- lib/domoscio_rails.tbz
+- lib/domoscio_rails/admin/company.rb
+- lib/domoscio_rails/admin/user.rb
+- lib/domoscio_rails/authorization_token.rb
+- lib/domoscio_rails/data/knowledge_node_student.rb
+- lib/domoscio_rails/data/result.rb
+- lib/domoscio_rails/errors.rb
+- lib/domoscio_rails/http_calls.rb
+- lib/domoscio_rails/json.rb
+- lib/domoscio_rails/knowledge/knowledge_edge.rb
+- lib/domoscio_rails/knowledge/knowledge_graph.rb
+- lib/domoscio_rails/knowledge/knowledge_node.rb
+- lib/domoscio_rails/resource.rb
+- lib/domoscio_rails/student/student.rb
+- lib/domoscio_rails/version.rb
+- lib/tasks/domoscio_rails_tasks.rake
+homepage: http://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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Summary of DomoscioRails.
+test_files: []