monokera-sdk 0.27.0

data/Guardfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(/^spec\/(.+)\/(.+)\/operations\/(.+)_example.rb$/) { |m| "spec/#{ m[1] }/#{ m[2] }/client_spec.rb" }
+  watch(/^lib\/(.+)\/(.+)\/operations\/(.+).rb$/) { |m| "spec/#{ m[1] }/#{ m[2] }/client_spec.rb" }
+end

data/README.md

@@ -0,0 +1,37 @@
+# Gem Monokera::SDK
+
+## Resources available in this SDK
+
+| Service Name            | Service Class         | API Version | Docs                                 |
+| ------------------------| ----------------------| ----------- |--------------------------------------|
+| Document Service        | Document              | v1          | [Docs](docs/document_service.md)     |
+| Policy Service          | Policy                | v1          | [Docs](docs/policy_service.md)       |
+| Pricing Service         | Pricing               | v1          | TODO: add reference to documentation |
+| Product Definition      | ProductDefinition     | v1          | [Docs](docs/product_definition.md)   |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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`.
+
+Include the changes description just below `[Unreleased]` title.
+
+## Versioning
+
+This project uses [semantic versioning](http://semver.org/spec/v2.0.0.html). You can safely
+express a dependency on a major version and expect all minor and patch versions
+to be backwards compatible.
+
+## How to release a new version
+
+**NOTE:** Avoid updating `CHANGELOG.md` and `version.rb` files manually to release the new version.
+
+After squash and merge your changes to master, you need to follow these steps:
+
+* Run `$ bin/bump minor`
+* To release a **major** or a **patch** version you can pass `major` or `patch` argument to `bin/bump`
+* Ex: `$ bin/bump patch` or `$ bin/bump major`
+* Open a Pull Request named `Bump version to x.y.z` and tag it as `release`
+
+If any error is found updating `CHANGELOG.md`, any change related with versioning is reverted.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/bump

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'gem/release/files/version'
+require_relative '../build_tools/changelog'
+
+target = ARGV.fetch(0, 'minor').to_sym
+
+begin
+  release = Gem::Release::Files::Version.new 'monokera-sdk', target, {}
+  release.version = release.from.split('-').first if target == :promote
+  release.bump
+
+  Changelog.new(release).bump
+rescue Changelog::CorruptedFileError => error
+  `git checkout lib/monokera/sdk/version.rb CHANGELOG.md`
+  puts error
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dotenv'
+require 'byebug'
+require 'pry'
+
+require 'monokera/sdk'
+
+Dotenv.load
+Pry.start

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+ln -s .env.example .env || :

data/build_tools/changelog.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'date'
+
+class Changelog
+  class CorruptedFileError < StandardError; end
+
+  attr_reader :version, :body
+
+  def initialize(version, changelog_path = 'CHANGELOG.md')
+    @version = version
+    @changelog_path = changelog_path
+    @body = File.read(changelog_path)
+  end
+
+  def bump
+    raise CorruptedFileError unless valid_content?
+
+    update_title!
+    update_links_section!
+
+    File.write(@changelog_path, body)
+  end
+
+  private
+
+  def valid_content?
+    body.include?(compare_head_section) && body.include?(unreleased_title)
+  end
+
+  def update_title!
+    @body.gsub!(unreleased_title, "## [Unreleased]\n\n## [#{ version.to }] - #{ Date.today }")
+  end
+
+  def update_links_section!
+    @body.gsub!(compare_head_section, "v#{ version.to }...HEAD\n#{ new_version_diff_link }")
+  end
+
+  def new_version_diff_link
+    # rubocop:disable Layout/LineLength
+    "[#{ version.to }]: https://github.com/monokera-tech/monokera-sdk-ruby/compare/v#{ version.from }...v#{ version.to }"
+    # rubocop:enable Layout/LineLength
+  end
+
+  def unreleased_title
+    '## [Unreleased]'
+  end
+
+  def compare_head_section
+    "v#{ version.from }...HEAD"
+  end
+end

data/build_tools/spec/changelog_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative '../changelog'
+
+RSpec.describe Changelog do
+  subject { Changelog.new version, changelog_path }
+
+  let(:changelog_path) { './build_tools/spec/fixtures/CHANGELOG.md' }
+  let(:version) { double(to: '2.0.0', from: '1.0.0') }
+
+  before do
+    allow(Date).to receive(:today).and_return(Date.new(2018, 1, 23))
+  end
+
+  describe '#bump' do
+    it 'creates a new version section with the Unreleased information' do
+      expect(File).to receive(:write)
+        .with(changelog_path, start_with("## [Unreleased]\n\n## [2.0.0] - 2018-01-23\n### [Added]\n- bump bin"))
+
+      subject.bump
+    end
+
+    it 'creates new Unreleased in diff link section' do
+      expect(File).to receive(:write).with(changelog_path, include('[Unreleased]: https://github.com/monokera-tech/monokera-sdk-ruby/compare/v2.0.0...HEAD'))
+
+      subject.bump
+    end
+
+    it 'creates new version link in diff link section' do
+      expect(File).to receive(:write).with(changelog_path, include('[2.0.0]: https://github.com/monokera-tech/monokera-sdk-ruby/compare/v1.0.0...v2.0.0'))
+
+      subject.bump
+    end
+  end
+end

data/build_tools/spec/fixtures/CHANGELOG.md

@@ -0,0 +1,11 @@
+# [Unreleased]
+
+- Add new attribute "agreements" in models (Assistance and Service)
+- bump bin
+
+## [0.1.0] - 2020-04-22
+
+- First release.
+
+[Unreleased]: https://github.com/monokera-tech/monokera-sdk-ruby/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/monokera-tech/monokera-sdk-ruby/compare/v0.0.0...v0.1.0

data/docs/product_definition.md

@@ -0,0 +1,48 @@
+# Monokera::SDK - ProductDefinition
+
+## Usage
+
+```rb
+require 'monokera/sdk/product'
+```
+
+It is recommended to create a file in the initializers of the configuration of each project with the name of monokera_sdk.rb to require the gem's own resources.
+
+## Configuration
+
+To use this client you should set the environment variables:
+
+* `PRODUCT_DEFINITION_API_URL`
+* `PRODUCT_DEFINITION_API_TIMEOUT` (optional, default 30)
+
+## resource operations
+
+### Monokera::SDK::Product.find(product_uid)
+
+Get the input data of a product as long as its uid is supplied.
+
+| Parameter       | Type   | Description                                           |
+|-----------------|--------|-------------------------------------------------------|
+| uid             | String | product uid ('col:product:basic')                     |
+
+Example.
+
+```rb
+Monokera::SDK::Product.find('basic_product')
+# => #<Monokera::SDK::Product:0x000055cef2cb4488 @name='hello', @goods=[#<ProductDefinition::Good:0x000055cef2c92ba8 @uid="col:good"...>
+```
+
+### Monokera::SDK::Product.all
+
+Gets all products.
+
+Example
+
+```rb
+Monokera::SDK::Product.all
+# => [
+  #<Monokera::SDK::Product:0x000055cef2cb4488 @name='hello', @goods=[#<ProductDefinition::Good:0x000055cef2c92ba8 @uid="col:good"...>,
+  #<Monokera::SDK::Product:0x000055cef2cb4489 @name='product', @goods=[#<ProductDefinition::Good:0x000055cef2c92ba9 @uid="col:good_product"...>,
+  #<Monokera::SDK::Product:0x000055cef2cb4490 @name='product_2', @goods=[#<ProductDefinition::Good:0x000055cef2c92ba2 @uid="col:good_product_2"...>]
+]
+```

data/lib/monokera/sdk.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'zeitwerk'
+require_relative 'sdk/config/gem_inflector'
+require_relative 'sdk/active_support_notifications'
+
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{ __dir__ }/..")
+loader.tag = 'monokera-sdk'
+loader.inflector = Monokera::SDK::Config::GemInflector.new
+loader.setup
+
+module Monokera
+  module SDK
+  end
+end

data/lib/monokera/sdk/active_client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Monokera
+  module SDK
+    class ActiveClient < Monokera::SDK::ClientBase
+      def self.for(service)
+        new(configuration: Monokera::SDK::Configurator.new(service))
+      end
+
+      def initialize(configuration: nil)
+        @configuration = configuration
+      end
+
+      def get(url, query_options = {})
+        http_response = connection.get(url, query_options, client_headers)
+        process_response(http_response)
+      end
+
+      def post(url, params, headers = {})
+        http_response = connection.post(url, params, client_headers.merge(headers))
+        process_response(http_response)
+      end
+
+      def put(url, params)
+        http_response = connection.put(url, params, client_headers)
+        process_response(http_response)
+      end
+
+      def destroy(url)
+        http_response = connection.delete(url, nil, client_headers)
+        process_response(http_response)
+      end
+
+      private
+
+      def client_headers
+        {
+          timezone: Time.zone.name,
+          tenant_name: Apartment::Tenant.current
+        }
+      end
+    end
+  end
+end

data/lib/monokera/sdk/active_model.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Monokera
+  module SDK
+    class ActiveModel < Model
+      def update(attrs = {})
+        url_params = { country_code: attributes[:country_code] }.merge(attrs)
+        response = self.class.client.put(self.class.resource_endpoint(id, url_params), attrs)
+        if response.success?
+          self.attributes = response.body
+          true
+        else
+          self.class.raven_context(response)
+          false
+        end
+      end
+
+      def update!(attrs)
+        update(attrs) || raise(ClientError, errors)
+      end
+
+      def save!
+        if id
+          update!(as_json)
+        else
+          self.class.create!(as_json)
+        end
+      end
+
+      def save
+        create_or_update
+      rescue ClientError
+        false
+      end
+
+      def destroy
+        response = self.class.client.destroy(self.class.resource_endpoint(id))
+
+        if response.success?
+          true
+        else
+          self.class.raven_context(response)
+          false
+        end
+      end
+
+      def new_record?
+        id.blank?
+      end
+
+      def persisted?
+        !new_record?
+      end
+
+      private
+
+      def create_or_update
+        if persisted?
+          update(attributes)
+        else
+          resource = self.class.create(as_json)
+          self.attributes = resource.attributes
+          resource.persisted?
+        end
+      end
+
+      class << self
+        def all(query_options = {})
+          response = client.get(collection_endpoint(query_options), query_options)
+
+          if response.success?
+            build_data(response.body)
+          else
+            raven_context(response)
+            raise ClientError, response.body[:errors]
+          end
+        end
+
+        def find(id, params = {})
+          response = client.get(resource_endpoint(id, params), params)
+
+          if response.success?
+            build(response.body)
+          else
+            raven_context(response)
+            raise ResourceNotFound, response.body[:errors]
+          end
+        end
+
+        def create(attrs, headers = {})
+          response = client.post(collection_endpoint(attrs), attrs, headers)
+
+          if response.success?
+            build(response.body)
+          else
+            new(response.body[:errors])
+          end
+        end
+
+        def create!(attrs, headers = {})
+          resource = create(attrs, headers)
+
+          if resource.persisted?
+            resource
+          else
+            raven_context(resource)
+            raise ClientError, resource.errors
+          end
+        end
+
+        def collection_endpoint(options = {})
+          self::BASE_ENDPOINT % options.to_hash.symbolize_keys
+        end
+
+        def resource_endpoint(id, options = {})
+          endpoint = options.present? ? collection_endpoint(options) : self::BASE_ENDPOINT
+          [endpoint, id].join('/')
+        end
+
+        def build(body)
+          new(body)
+        end
+
+        def build_data(body)
+          if const_defined?(:ADAPTER) && self::ADAPTER == :json_api
+            body[:data].map { |resource_body| new(serialize_keys_json_api(resource_body[:attributes])) }
+          else
+            body.map { |resource_body| new(resource_body) }
+          end
+        end
+
+        def serialize_keys_json_api(data)
+          data.deep_transform_keys! { |key| key.to_s.underscore }
+        end
+
+        def raven_context(response)
+          Raven.extra_context(sdk_response: response.to_hash) if defined?(Raven)
+        end
+
+        private
+
+        def contains_pagination_headers?(headers)
+          headers.include?('x-total-pages')
+        end
+      end
+    end
+
+    class ClientError < StandardError; end
+  end
+end