omcms-ruby-client 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5deece1d451527de6ac82ca314828492c15fcfa0fbb940144d86819d3a913ee7
+  data.tar.gz: d50b85197535e0d418ff0c8daf3b750e3c0843dd488dc80123658e8a7362312a
+SHA512:
+  metadata.gz: a94d610dae99e9c644af1f572699d4db310a81a660dd39f77313d8daa1743ed1da3105ec841103fa6b80840bf96187b4cb597bb454cbabc1f920aa9830588a7b
+  data.tar.gz: 69e4a929a5a5841dabfd50118afdcee8732615dc98db7d72169bace4d3d6583066b67df9b444e270c0b04fba5a95a88dbd5cd894afb46df8a18ba3925563609f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omcms-ruby-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,83 @@
+# OMCMS
+
+This gem is a ruby wrapper of OMCMS API's
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omcms-ruby-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omcms-ruby-client
+
+## Usage
+
+Create a client using your OMCMS connector's public key and private key
+
+```ruby
+# config/initializers/omcms.rb
+
+$omcms = OMCMS::Client.new(
+  host: ENV["OMCMS_API_HOST"], # http://localhost:8877
+  public_key: ENV["OMCMS_PUBLIC_KEY"],
+  private_key: ENV["OMCMS_PRIVATE_KEY"]
+)
+```
+
+### Offering
+
+You can fetch all or specific offering with `OMCMS::Client`
+
+```ruby
+offerings = $omcms.offerings.all
+# => fetch all offerings available on OMCMS
+
+offering = $omcms.offerings.get(123)
+# => offering(id = 123) fetched from OMCMS
+```
+
+### Component
+
+You can fetch all or specific component with specified `offering`
+
+```ruby
+offering = $omcms.offerings.get(123)
+
+components = offering.components.all
+# => all components of offering(id = 123)
+
+component = offering.components.get(456)
+# => component(id = 456) of offering(id = 123)
+```
+
+### Offering Data
+
+You can fetch all or specific offering_data with specified `offering`
+
+```ruby
+offering = $omcms.offerings.get(123)
+
+offering_data = offering.data.all
+# => all offering_data of offering(id = 123)
+
+offering_data = offering.data.get(456)
+# => offering_data(id: 456) of offering(id = 123)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/equitymultiple/omcms-ruby-client.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omcms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omcms/client.rb

@@ -0,0 +1,42 @@
+module OMCMS
+  class Client
+    attr_reader :client
+
+    def initialize(opts)
+      configure_credentials(opts)
+      configure_client
+    end
+
+    def faraday &block
+      @faraday = block if block
+      @faraday
+    end
+
+    def configure_client
+      @client ||= Faraday.new do |f|
+        f.request :basic_auth, @username, @password
+        f.use SetHeader
+        f.use ParseResponse
+        f.response :json, :content_type => /\bjson$/
+        faraday.call(f) if faraday
+        f.adapter Faraday.default_adapter unless faraday
+      end
+    end
+
+    def offerings
+      OMCMS::Offering.new(@client, @response, @host)
+    end
+
+    private
+
+    def configure_credentials(opts)
+      raise ArgumentError.new "Public Key is missing for the OMCMS client" if opts[:public_key].to_s.empty?
+      raise ArgumentError.new "Private Key is missing for the OMCMS client" if opts[:private_key].to_s.empty?
+      raise ArgumentError.new "Host is missing for the OMCMS client" if opts[:host].to_s.empty?
+
+      @username = opts[:public_key]
+      @password = opts[:private_key]
+      @host = opts[:host]
+    end
+  end
+end

data/lib/omcms/middleware/parse_response.rb

@@ -0,0 +1,17 @@
+module OMCMS
+  class ParseResponse
+    def initialize app
+      @app = app
+    end
+
+    def call request_env
+      @app.call(request_env).on_complete do |response_env|
+        if response_env.status >= 400
+          return OMCMS::Response::Error.new(response_env)
+        else
+          return response_env.body
+        end
+      end
+    end
+  end
+end

data/lib/omcms/middleware/set_header.rb

@@ -0,0 +1,16 @@
+module OMCMS
+  class SetHeader
+    HEADERS = {
+      :"user-agent" => "omcms/ruby/client/#{VERSION}"
+    }
+
+    def initialize app
+      @app = app
+    end
+
+    def call request_env
+      request_env[:request_headers].merge! HEADERS
+      @app.call(request_env)
+    end
+  end
+end

data/lib/omcms/resource/component.rb

@@ -0,0 +1,22 @@
+module OMCMS
+  class Component < Resource
+    def initialize(client, response = {}, host)
+      @offering_id = response["id"]
+      super
+    end
+
+    def all
+      perform_run self, request_path()
+    end
+
+    def get(id)
+      perform_run self, request_path(id)
+    end
+
+    private
+
+    def request_path(key = nil)
+      ["offerings", @offering_id, "components", key].compact.join("/")
+    end
+  end
+end

data/lib/omcms/resource/offering.rb

@@ -0,0 +1,21 @@
+module OMCMS
+  class Offering < Resource
+    def initialize(client, response, host)
+      super
+    end
+
+    def all
+      perform_run self, request_path()
+    end
+
+    def get(id)
+      perform_run self, request_path(id)
+    end
+
+    private
+
+    def request_path(key = nil)
+      ["offerings", key].compact.join("/")
+    end
+  end
+end

data/lib/omcms/resource/offering_data.rb

@@ -0,0 +1,22 @@
+module OMCMS
+  class OfferingData < Resource
+    def initialize(client, response = {}, host)
+      @offering_id = response["id"]
+      super
+    end
+
+    def all
+      perform_run self, request_path()
+    end
+
+    def get(id)
+      perform_run self, request_path(id)
+    end
+
+    private
+
+    def request_path(key = nil)
+      ["offerings", @offering_id, "data", key].compact.join("/")
+    end
+  end
+end

data/lib/omcms/resource.rb

@@ -0,0 +1,23 @@
+module OMCMS
+  class Resource
+    def initialize(client, response = {}, host = nil)
+      @client = client
+      @host = host
+    end
+
+    private
+
+    def response_class(name)
+      Kernel.const_get("OMCMS::Response::#{name}")
+    end
+
+    def perform_run(instance, path)
+      request_url = [@host, "api", "apps", path].compact.join("/")
+      class_name = instance.class.name.split("::").last
+      response = @client.get request_url
+
+      return response if response.class == OMCMS::Response::Error
+      response_class(class_name).new(@client, response, @host)
+    end
+  end
+end

data/lib/omcms/response/body.rb

@@ -0,0 +1,46 @@
+module OMCMS
+  module Response
+    class Body
+      attr_reader :body
+
+      def initialize(client, response, host)
+        @client = client
+        @body = response
+        @host = host
+      end
+
+      def to_json
+        parse(@body)
+      end
+
+      private
+
+      def parse(data = "")
+        if data.class == Hash
+          return data.keys.map do |attribute|
+            key = snakecase(attribute)
+            [key, parse(data[attribute])]
+          end.to_h
+        elsif data.class == Array
+          return data.map do |object|
+            hash = object.keys.map do |attribute|
+              key = snakecase(attribute)
+              [key, parse(object[attribute])]
+            end.to_h
+          end
+        end
+        return data
+      end
+
+
+      def snakecase(data = "")
+        data.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .tr('-', '_')
+            .gsub(/\s/, '_')
+            .gsub(/__+/, '_')
+            .downcase
+      end
+    end
+  end
+end

data/lib/omcms/response/component.rb

@@ -0,0 +1,9 @@
+module OMCMS
+  module Response
+    class Component < Body
+      def initialize(client, data, host)
+        super
+      end
+    end
+  end
+end

data/lib/omcms/response/error.rb

@@ -0,0 +1,47 @@
+module OMCMS
+  module Response
+    class Error < StandardError
+      attr_reader :status
+
+      def initialize response
+        return unless response
+        unless response.respond_to? :body
+          response = add_body_to_error(response)
+        end
+
+        response.body.each do |key, value|
+          instance_variable_set("@#{key}", value)
+          self.class.send(:attr_reader, key)
+        end
+      end
+
+      def to_json
+        self.instance_variables.map do |attribute|
+          key = attribute.to_s.gsub('@','')
+          [snakecase(key), self.instance_variable_get(attribute)]
+        end.to_h
+      end
+
+      private
+
+      def add_body_to_error(response)
+        OpenStruct.new(
+          body: {
+            statusCode: 400,
+            name: "Bad Request",
+            message: response
+          }
+        )
+      end
+
+      def snakecase(data = "")
+        data.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .tr('-', '_')
+            .gsub(/\s/, '_')
+            .gsub(/__+/, '_')
+            .downcase
+      end
+    end
+  end
+end

data/lib/omcms/response/offering.rb

@@ -0,0 +1,17 @@
+module OMCMS
+  module Response
+    class Offering < Body
+      def initialize(client, data, host)
+        super
+      end
+
+      def components
+        OMCMS::Component.new(@client, self.body, @host)
+      end
+
+      def data
+        OMCMS::OfferingData.new(@client, self.body, @host)
+      end
+    end
+  end
+end

data/lib/omcms/response/offering_data.rb

@@ -0,0 +1,9 @@
+module OMCMS
+  module Response
+    class OfferingData < Body
+      def initialize(client, data, host)
+        super
+      end
+    end
+  end
+end

data/lib/omcms/version.rb

@@ -0,0 +1,3 @@
+module OMCMS
+  VERSION = "1.0.0-alpha"
+end

data/lib/omcms.rb

@@ -0,0 +1,22 @@
+require "faraday"
+require "faraday_middleware"
+
+require "omcms/client"
+require "omcms/resource"
+require "omcms/version"
+
+require "omcms/resource/offering"
+require "omcms/resource/component"
+require "omcms/resource/offering_data"
+
+require "omcms/response/body"
+require "omcms/response/error"
+require "omcms/response/offering"
+require "omcms/response/component"
+require "omcms/response/offering_data"
+
+require "omcms/middleware/set_header"
+require "omcms/middleware/parse_response"
+
+module OMCMS
+end

data/omcms-ruby-client.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omcms/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omcms-ruby-client"
+  spec.version       = OMCMS::VERSION
+  spec.authors       = ["Pradeep Rawat"]
+  spec.email         = ["pradeep@akaruilabs.com"]
+
+  spec.summary       = %q{A Ruby SDK for OMCMS APIs}
+  spec.description   = %q{omcms-ruby-client make is simpler to use OMCMS connector APIs and integrate with existing Ruby application}
+  spec.homepage      = "https://github.com/equitymultiple/omcms-ruby-client"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/equitymultiple/omcms-ruby-client"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.15"
+  spec.add_dependency "faraday_middleware", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: omcms-ruby-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Pradeep Rawat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: omcms-ruby-client make is simpler to use OMCMS connector APIs and integrate
+  with existing Ruby application
+email:
+- pradeep@akaruilabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omcms.rb
+- lib/omcms/client.rb
+- lib/omcms/middleware/parse_response.rb
+- lib/omcms/middleware/set_header.rb
+- lib/omcms/resource.rb
+- lib/omcms/resource/component.rb
+- lib/omcms/resource/offering.rb
+- lib/omcms/resource/offering_data.rb
+- lib/omcms/response/body.rb
+- lib/omcms/response/component.rb
+- lib/omcms/response/error.rb
+- lib/omcms/response/offering.rb
+- lib/omcms/response/offering_data.rb
+- lib/omcms/version.rb
+- omcms-ruby-client.gemspec
+homepage: https://github.com/equitymultiple/omcms-ruby-client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/equitymultiple/omcms-ruby-client
+  source_code_uri: https://github.com/equitymultiple/omcms-ruby-client
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby SDK for OMCMS APIs
+test_files: []