apicco-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f1c77ce5e818f6c2db82b6d6b43c751facb7eb2d46dd2e63a3afde6e8192af4
+  data.tar.gz: 0bb26bbae5c365f893116e1f404e0bac2b9427bb7ce094cbad9711c675d82046
+SHA512:
+  metadata.gz: e76ff5a137c475e0b9b69b1a24e270f8e57c260c0de5bbb637301e796ee81a61993daabff928456dd6f7853a40775c30bf66f57a9b29ebe5bcf78cd578015078
+  data.tar.gz: 2abc94f83a75f48808215d3f56216c64488fb826e6879e1d72d6a7c3c02b90235064692e57f76cecf3cc210ef03001a63587532886ff49e9e6461d98a0c502ce

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.idea

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  Exclude:
+    - "config/**/*.rb"
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/ClassLength:
+  Max: 1000
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 40
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+ruby "~> 2.6"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in apicco.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Apicco-SDK
+
+Apicco SDK creates dynamically an [Apicco API](https://github.com/SokratisVidros/apicco/blob/master/lib/README.md) client, that works both in Node and browser environments.
+
+Port of [JS Apicco-SDK](../js/README.md) in Ruby.
+
+```
+POST /api/movies.create      api.movies_create(title: 'Foo')
+POST /api/movies.info        api.movies_info(movie_id: 42)
+POST /api/movies.list        api.movies_list
+POST /api/movies.update      api.movies_update(movie_id: 42, title: 'Bar')
+POST /api/movies.delete      api.movies_delete(movie_id: 42)
+```
+
+## Usage
+
+```ruby
+require 'apicco-sdk'
+> token = 'deadbeef'
+> intercept = ->(req) { req[:headers]["Authorization"]="Bearer #{token}" }
+> api = ::ApiccoSDK::Client.new('http://example.com', rel_path:'api/v2', intercept:intercept)
+> api.movies_list
+```
+
+## RPC style method invocation
+
+Apicco SDK enables developers to invoke remote endpoints in an RPC fashion. For example:
+
+```
+POST /api/users.sayHello  =>  api.users_sayHello(name: 'John Doe')
+```
+
+## Minimal versionless clients
+
+Apicco SDK leverages discovery endpoint and fetches latest API description upon initialization. That way, client updates are not required when the API is modified and changes are backwards compatible.
+
+Moreover, client size is minimal since there is no static code for any of endpoint.
+
+## Human friendly error messages
+
+Apicco API returns JSON error objects that contain human friendly error messages. For example when `foo_id` request parameter validation fails, the following error will be returned to the client:
+
+```json
+{
+  "error": "Bad Request",
+  "message": "Invalid Request Body - child \"foo_id\" fails because [\"foo_id\" must be a number]",
+  "statusCode": 400
+```
+
+## Options
+
+**origin** (Required positional argument)
+
+Specify the origin of the Apicco API server
+
+**rel_path**
+
+Specify the relative of the Apicco API
+
+_Defaults to `api/v1`_
+
+**intercept**
+
+Specify an interceptor lamdbda that will be executed before each request
+
+_Defaults to `->(req) { req }`_
+
+**api**
+
+Specify the discovery endpoint response as hash to avoid the request
+
+_Defaults to `{}`_

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/apicco_sdk.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "apicco_sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "apicco-sdk"
+  spec.version       = ApiccoSDK::VERSION
+  spec.authors       = ["Dimitris Klouvas"]
+  spec.email         = ["dimitris.klouvas@gmail.com"]
+
+  spec.summary       = "Apicco Ruby SDK"
+  spec.description   = "Apicco Ruby SDK to export client using discovery service"
+  spec.homepage      = "https://github.com/sokratisvidros/apicco#readme"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "json", "~> 2.2.0"
+  spec.add_dependency "rest-client", "~> 2.0.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "gem-release", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "mocha", "~> 1.7"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apicco_sdk"
+
+# 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/publish

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+gem build apicco_sdk.gemspec
+gem push apicco-sdk-*.gem
+rm apicco-sdk-*.gem

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/bin/version.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+gem bump --version ${1:-'patch'} --no-commit
+
+_package=`node -e "console.log(require('./package.json').name)"`
+_version=`npm version --no-git-tag-version ${1:-'patch'}`
+
+git commit -am "Version bump $_package@$_version"
+# git tag "$_package@$_version"

data/lib/apicco_sdk.rb

@@ -0,0 +1,5 @@
+require "json"
+require "rest-client"
+require "apicco_sdk/version"
+require "apicco_sdk/helpers"
+require "apicco_sdk/client"

data/lib/apicco_sdk/client.rb

@@ -0,0 +1,83 @@
+module ApiccoSDK
+  class Client
+    include ::ApiccoSDK::Helpers
+
+    def initialize(origin, rel_path:'api/v1', api:{}, intercept: ->(req) { req })
+      @rel_path = rel_path
+      @origin = origin
+      @intercept = intercept
+      @api = discover_api(api)
+    end
+
+    def method_missing(m, *args, &block)
+      method_name = m.to_s
+      super unless @api.key?(method_name)
+
+      data = (args[0] || {}).transform_keys!(&:to_s) 
+
+      action, params = @api[method_name]
+
+      required_params = params.inject([]) do |memo, p|
+        memo << p[1..-1] if p[0] == "*"
+        memo
+      end
+
+      missing_params = required_params.select { |p| data[p].nil? }
+
+      fail "#{m} missing params: #{missing_params.join(", ")}" if missing_params.any?
+      request(:post, "#{@url}/#{action}", data.to_json)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @api.key?(method_name) || super
+    end
+
+    private
+
+    def url
+      @url ||= "#{@origin}/#{@rel_path}"
+    end
+
+    def discover_api(api)
+      api = request(:get, "#{url}/discovery") if api.nil? || api.empty?
+      parse_api_hash(api)
+    end
+
+    def parse_api_hash(h)
+      h
+        .inject({}) do |memo, item|
+          k, v = item
+          new_key = underscore(k.gsub(".", "_"))
+          memo[new_key] = [k, v]
+          memo
+        end
+    end
+
+    def request(method, url, payload = nil, headers = {})
+      response = _execute(method, url, payload, headers)
+      parse_response(response) unless response.code == 204
+    rescue ::RestClient::ExceptionWithResponse => e
+      raise e if e.http_code > 501
+      parse_response(e.response)
+    end
+
+    def parse_response(res)
+      JSON.parse(res)
+    end
+
+    def _execute(method, url, payload, headers)
+      req = {
+        method: method, 
+        url: url, 
+        payload: payload,
+        content_type: :json,
+        headers: {
+          Accept: "application/json",
+          "User-Agent" => "Apicco Ruby SDK #{VERSION}"
+        }.merge(headers)
+      }
+      @intercept.call(req)
+      ::RestClient::Request.execute(req)
+    end
+  end
+end

data/lib/apicco_sdk/helpers.rb

@@ -0,0 +1,17 @@
+module ApiccoSDK
+  module Helpers
+    ACRONYM_REGEX             = /(?=a)b/
+    ACRONYMS_UNDERSCORE_REGEX = /(?:(?<=([A-Za-z\d]))|\b)(#{ACRONYM_REGEX})(?=\b|[^a-z])/
+    # see: https://github.com/rails/rails/blob/76ae3dbed301d7178c221b0c957c6b73464eec58/activesupport/lib/active_support/inflector/methods.rb#L92
+    def underscore(camel_cased_word)
+      return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+      word = camel_cased_word.to_s.gsub("::", "/")
+      word.gsub!(ACRONYMS_UNDERSCORE_REGEX) { "#{$1 && '_' }#{$2.downcase}" }
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/apicco_sdk/version.rb

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

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: apicco-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dimitris Klouvas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !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: gem-release
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Apicco Ruby SDK to export client using discovery service
+email:
+- dimitris.klouvas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- apicco_sdk.gemspec
+- bin/console
+- bin/publish
+- bin/setup
+- bin/version.sh
+- lib/apicco_sdk.rb
+- lib/apicco_sdk/client.rb
+- lib/apicco_sdk/helpers.rb
+- lib/apicco_sdk/version.rb
+homepage: https://github.com/sokratisvidros/apicco#readme
+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.3
+signing_key: 
+specification_version: 4
+summary: Apicco Ruby SDK
+test_files: []