crapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e07d4b09fda54c274d947572692e0ca65cffeea63cc0dddb7d007417e21db00f
+  data.tar.gz: f7ac47fd70689d196806c773e3c68de646a57582ae53532d0393da1591e12b53
+SHA512:
+  metadata.gz: e60ac2a214b04c9ba04e873242f12524dea1c26e1e97f9583ae42c0090908cce490b457e41cc0ac6bacbf88956b195df9ca805102c03de0ff54d24e79625e0fa
+  data.tar.gz: 58c452c73c69a95ce88567a0fc7d794c9920c085051db8f18450b87e93e82a23a7783794dca576c82a14c406a662cb6191f05f7e150d058947534e8b7295caf5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/true/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,81 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+  - "**/*.rake"
+  - "**/Gemfile"
+  - "**/Rakefile"
+  - "**/Capfile"
+  - "**/Berksfile"
+  - "**/Cheffile"
+  Exclude:
+  - "vendor/**/*"
+  - "db/**/*"
+  - "tmp/**/*"
+  - "true/**/*"
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/LineLength:
+  Description: Limit lines to 100 characters.
+  Enabled: false
+  Max: 100
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and conditions.
+  Enabled: false
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Lint/Debugger:
+  Description: Warn in debugger entries
+  Enabled: false
+Style/SymbolArray:
+  Description: Use %i or %I for arrays of symbols.
+  Enabled: false
+Style/RegexpLiteral:
+  Description: Enforces using / or %r around regular expressions.
+  EnforcedStyle: percent_r
+Style/AsciiComments:
+  # Disabling this so we can use non-breaking spaces (' ') in documentation comments, preventing browsers from collapsing multiple spaces in code blocks.
+  Description: This cop checks for non-ascii (non-English) characters in comments.
+  Enabled: false
+Style/NumericLiterals:
+  Description: This cop checks for big numeric literals without _ between groups of digits in them.
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Description: Use nested modules/class definitions instead of compact style.
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Style/StderrPuts:
+  Enabled: true
+  Exclude:
+    - 'bin/**/*'
+Style/BlockDelimiters:
+  Description: Check for uses of braces or do/end around single line or multi-line blocks.
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+Style/RescueModifier:
+  Description: This cop checks for uses of rescue in its modifier form.
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Description: This cop checks method parameter names for how descriptive they are.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/.yardopts

@@ -0,0 +1 @@
+--output-dir=./docs --no-private --markup=markdown --format=html

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    crapi (0.1.0)
+      activesupport (~> 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  crapi!
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nestor Custodio
+
+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,39 @@
+# Crapi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/crapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crapi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/crapi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 'crapi'
+
+# 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/crapi.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'crapi'
+  spec.version       = Crapi::VERSION
+  spec.authors       = ['Nestor Custodio']
+  spec.email         = ['sakimorix@gmail.com']
+
+  spec.summary       = 'A simple API client with built-in segment/header proxy support. "... It could be better." ™️'
+  spec.homepage      = 'https://www.github.com/nestor-custodio/crapi'
+  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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
+
+  spec.add_dependency 'activesupport', '~> 5.2'
+end

data/lib/crapi.rb

@@ -0,0 +1,6 @@
+require 'crapi/client'
+require 'crapi/proxy'
+require 'crapi/version'
+
+module Crapi
+end

data/lib/crapi/client.rb

@@ -0,0 +1,139 @@
+require 'active_support/all'
+require 'net/http'
+require 'openssl'
+
+require 'crapi/proxy'
+
+class Crapi::Client
+  attr_accessor :default_headers
+
+  JSON_CONTENT_TYPE = 'application/json'.freeze
+  FORM_CONTENT_TYPE = 'application/x-www-form-urlencoded'.freeze
+
+  def initialize(base_uri, opts = {})
+    @base_uri = case base_uri
+                when URI then base_uri
+                when String then URI(base_uri)
+                else raise Crapi::ArgumentError, %(Unexpected "base_url" type: #{base_url.class})
+                end
+
+    @proxy_host = opts[:proxy_host]
+    @proxy_port = opts[:proxy_port]
+    @proxy_username = opts[:proxy_username]
+    @proxy_password = opts[:proxy_password]
+
+    @http = Net::HTTP.new(@base_uri.host, @base_uri.port,
+                          @proxy_host, @proxy_port, @proxy_username, @proxy_password)
+    @http.use_ssl = (@base_uri.scheme == 'https')
+    @http.verify_mode = ::OpenSSL::SSL::VERIFY_NONE if opts[:insecure].present?
+
+    @default_headers = { 'Content-Type': JSON_CONTENT_TYPE }.with_indifferent_access
+  end
+
+  def new_proxy(segment = '/', headers: nil)
+    Crapi::Proxy.new(add: segment, to: self, headers: headers)
+  end
+
+  ## CRUD methods ...
+
+  def delete(path, headers: {}, query: {})
+    headers = @default_headers.merge(headers)
+
+    response = @http.delete(full_path(path, query: query), headers)
+    ensure_success!(response)
+    parse_response(response)
+  end
+
+  def get(path, headers: {}, query: {})
+    headers = @default_headers.merge(headers)
+
+    response = @http.get(full_path(path, query: query), headers)
+    ensure_success!(response)
+    parse_response(response)
+  end
+
+  def patch(path, headers: {}, query: {}, payload: {})
+    headers = @default_headers.merge(headers)
+    payload = format_payload(payload, as: headers[:'Content-Type'])
+
+    response = @http.patch(full_path(path, query: query), payload, headers)
+    ensure_success!(response)
+    parse_response(response)
+  end
+
+  def post(path, headers: {}, query: {}, payload: {})
+    headers = @default_headers.merge(headers)
+    payload = format_payload(payload, as: headers[:'Content-Type'])
+
+    response = @http.post(full_path(path, query: query), payload, headers)
+    ensure_success!(response)
+    parse_response(response)
+  end
+
+  def put(path, headers: {}, query: {}, payload: {})
+    headers = @default_headers.merge(headers)
+    payload = format_payload(payload, as: headers[:'Content-Type'])
+
+    response = @http.put(full_path(path, query: query), payload, headers)
+    ensure_success!(response)
+    parse_response(response)
+  end
+
+  ##
+
+  private
+
+  ##
+
+  def full_path(path, query: {})
+    path = [@base_uri.path, path].map { |i| i.gsub(%r{^/|/$}, '') }.keep_if(&:present?)
+    path = "/#{path.join('/')}"
+
+    if query.present?
+      path += case query
+              when Hash, Array then "?#{URI.encode_www_form(query)}"
+              when String then "?#{query}"
+              else raise Crapi::ArgumentError, %(Unexpected "query" type: #{query.class})
+              end
+    end
+
+    path
+  end
+
+  def ensure_success!(response)
+    return if response.is_a? Net::HTTPSuccess
+    raise(Crapi::BadHttpResponseError, "#{response.code} - #{response.message}")
+  end
+
+  def format_payload(payload, as: JSON_CONTENT_TYPE)
+    ## Non-Hash payloads are passed through as-is.
+    return payload unless payload.is_a? Hash
+
+    ## Massage Hash-like payloads into a suitable format.
+    case as
+    when JSON_CONTENT_TYPE
+      JSON.generate(payload.as_json)
+    when FORM_CONTENT_TYPE
+      payload.to_query
+    else
+      payload.to_s
+    end
+  end
+
+  def parse_response(response)
+    case response.content_type
+    when JSON_CONTENT_TYPE
+      JSON.parse(response.body, quirks_mode: true, symbolize_names: true)
+    else
+      response.body
+    end
+  end
+end
+
+## Net::HTTP needs a shortcut instance method for PUT calls like it does for GET/DELETE/PATCH/POST.
+##
+class Net::HTTP
+  def put(path, data, initheader = nil, dest = nil, &block)
+    send_entity(path, data, initheader, dest, Put, &block)
+  end
+end

data/lib/crapi/errors.rb

@@ -0,0 +1,10 @@
+module Crapi
+  class Error < ::StandardError
+  end
+
+  class ArgumentError < Error
+  end
+
+  class BadHttpResponseError < Error
+  end
+end

data/lib/crapi/proxy.rb

@@ -0,0 +1,42 @@
+require 'active_support/all'
+
+class Crapi::Proxy
+  attr_accessor :default_headers
+
+  def initialize(add:, to:, headers: nil)
+    @parent = to
+    @segment = add
+    @default_headers = (headers || {}).with_indifferent_access
+  end
+
+  def new_proxy(segment = '/', headers: nil)
+    Crapi::Proxy.new(add: segment, to: self, headers: headers)
+  end
+
+  ## CRUD methods ...
+
+  def delete(path, headers: {}, query: {})
+    @parent.delete("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
+                   headers: @default_headers.merge(headers), query: query)
+  end
+
+  def get(path, headers: {}, query: {})
+    @parent.get("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
+                headers: @default_headers.merge(headers), query: query)
+  end
+
+  def patch(path, headers: {}, query: {}, payload: {})
+    @parent.patch("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
+                  heades: @default_headers.merge(headers), query: query, payload: payload)
+  end
+
+  def post(path, headers: {}, query: {}, payload: {})
+    @parent.post("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
+                 headers: @default_headers.merge(headers), query: query, payload: payload)
+  end
+
+  def put(path, headers: {}, query: {}, payload: {})
+    @parent.put("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
+                headers: @default_headers.merge(headers), query: query, payload: payload)
+  end
+end

data/lib/crapi/version.rb

@@ -0,0 +1,3 @@
+module Crapi
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: crapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nestor Custodio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: 
+email:
+- sakimorix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crapi.gemspec
+- lib/crapi.rb
+- lib/crapi/client.rb
+- lib/crapi/errors.rb
+- lib/crapi/proxy.rb
+- lib/crapi/version.rb
+homepage: https://www.github.com/nestor-custodio/crapi
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A simple API client with built-in segment/header proxy support. "... It could
+  be better." ™️
+test_files: []