crapi 0.1.3 → 1.0.1

data/lib/crapi/proxy.rb

@@ -1,120 +1,120 @@
 require 'active_support/all'
 
-module Crapi
-  ## Proxies simple CRUD methods ({#delete} / {#get} / {#patch} / {#post} / {#put}) for a
-  ## {Crapi::Client Crapi::Client} or another {Crapi::Proxy Crapi::Proxy}. Like
-  ## {Crapi::Client Crapi::Client}, it also provides a proxy generator.
-  ##
-  ## A {Crapi::Proxy Crapi::Proxy} has its own set of default headers and has a segment that is
-  ## prepended to its CRUD methods' *path* before being passed to the parent
-  ## {Crapi::Client Crapi::Client}/{Crapi::Proxy Crapi::Proxy}. This makes the proxxy functionally
-  ## equivalent to a new {Crapi::Client Crapi::Client} with a new base path (the parent's base path
-  ## plus the proxy's segment) and more default headers, but without the need for a separate
-  ## connection to the target system.
-  ##
+module CrAPI
+  # Proxies simple CRUD methods ({#delete} / {#get} / {#patch} / {#post} / {#put}) for a
+  # {CrAPI::Client CrAPI::Client} or another {CrAPI::Proxy CrAPI::Proxy}. Like
+  # {CrAPI::Client CrAPI::Client}, it also provides a proxy generator.
+  #
+  # A {CrAPI::Proxy CrAPI::Proxy} has its own set of default headers and has a segment that is
+  # prepended to its CRUD methods' *path* before being passed to the parent
+  # {CrAPI::Client CrAPI::Client}/{CrAPI::Proxy CrAPI::Proxy}. This makes the proxxy functionally
+  # equivalent to a new {CrAPI::Client CrAPI::Client} with a new base path (the parent's base path
+  # plus the proxy's segment) and more default headers, but without the need for a separate
+  # connection to the target system.
+  #
   class Proxy
-    ## A Hash containing headers to send with every request (unless overriden elsewhere). In case of
-    ## conflicts, headers set as default for a {Crapi::Proxy Crapi::Proxy} override those set by the
-    ## parent. As in a {Crapi::Client Crapi::Client}, headers set by the user via the CRUD methods'
-    ## *headers* still override any conflicting default header.
-    ##
-    ##
-    ## @see Crapi::Client#default_headers Crapi::Client#default_headers
-    ##
+    # A Hash containing headers to send with every request (unless overriden elsewhere). In case of
+    # conflicts, headers set as default for a {CrAPI::Proxy CrAPI::Proxy} override those set by the
+    # parent. As in a {CrAPI::Client CrAPI::Client}, headers set by the user via the CRUD methods'
+    # *headers* still override any conflicting default header.
+    #
+    #
+    # @see CrAPI::Client#default_headers CrAPI::Client#default_headers
+    #
     attr_accessor :default_headers
 
-    ## @param add [String]
-    ##   The new base path. This path (added to the parent's base path) will be used as the base
-    ##   path for the {Crapi::Proxy Crapi::Proxy}'s CRUD methods.
-    ##
-    ## @param to [Crapi::Client, Crapi::Proxy]
-    ##   The parent {Crapi::Client Crapi::Client} or {Crapi::Proxy Crapi::Proxy} that we'll be
-    ##   delegating CRUD calls to after proprocessing of headers and paths.
-    ##
-    ## @param headers [Hash]
-    ##   The default headers to send with every request (unless overriden elsewhere).
-    ##
+    # @param add [String]
+    #   The new base path. This path (added to the parent's base path) will be used as the base
+    #   path for the {CrAPI::Proxy CrAPI::Proxy}'s CRUD methods.
+    #
+    # @param to [CrAPI::Client, CrAPI::Proxy]
+    #   The parent {CrAPI::Client CrAPI::Client} or {CrAPI::Proxy CrAPI::Proxy} that we'll be
+    #   delegating CRUD calls to after proprocessing of headers and paths.
+    #
+    # @param headers [Hash]
+    #   The default headers to send with every request (unless overriden elsewhere).
+    #
     def initialize(add:, to:, headers: nil)
       @parent = to
       @segment = add
       @default_headers = (headers || {}).with_indifferent_access
     end
 
-    ## Returns a new {Crapi::Proxy Crapi::Proxy} for this proxy.
-    ##
-    ##
-    ## @param segment [String]
-    ##   The segment to add to this proxy's path.
-    ##
-    ## @param headers [Hash]
-    ##   The default headers for the new proxy.
-    ##
-    ##
-    ## @return [Crapi::Proxy]
-    ##
-    ## @see Crapi::Client#new_proxy Crapi::Client#new_proxy
-    ##
+    # Returns a new {CrAPI::Proxy CrAPI::Proxy} for this proxy.
+    #
+    #
+    # @param segment [String]
+    #   The segment to add to this proxy's path.
+    #
+    # @param headers [Hash]
+    #   The default headers for the new proxy.
+    #
+    #
+    # @return [CrAPI::Proxy]
+    #
+    # @see CrAPI::Client#new_proxy CrAPI::Client#new_proxy
+    #
     def new_proxy(segment = '/', headers: nil)
       Proxy.new(add: segment, to: self, headers: headers)
     end
 
-    ## CRUD methods ...
+    # CRUD methods ...
 
-    ## CRUD method: DELETE
-    ##
-    ##
-    ## @return [Object]
-    ##
-    ## @see Crapi::Client#delete Crapi::Client#delete
-    ##
+    # CRUD method: DELETE
+    #
+    #
+    # @return [Object]
+    #
+    # @see CrAPI::Client#delete CrAPI::Client#delete
+    #
     def delete(path, headers: {}, query: {})
       @parent.delete("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
                      headers: @default_headers.merge(headers), query: query)
     end
 
-    ## CRUD method: GET
-    ##
-    ##
-    ## @return [Object]
-    ##
-    ## @see Crapi::Client#get Crapi::Client#get
-    ##
+    # CRUD method: GET
+    #
+    #
+    # @return [Object]
+    #
+    # @see CrAPI::Client#get CrAPI::Client#get
+    #
     def get(path, headers: {}, query: {})
       @parent.get("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
                   headers: @default_headers.merge(headers), query: query)
     end
 
-    ## CRUD method: PATCH
-    ##
-    ##
-    ## @return [Object]
-    ##
-    ## @see Crapi::Client#patch Crapi::Client#patch
-    ##
+    # CRUD method: PATCH
+    #
+    #
+    # @return [Object]
+    #
+    # @see CrAPI::Client#patch CrAPI::Client#patch
+    #
     def patch(path, headers: {}, query: {}, payload: {})
       @parent.patch("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
-                    heades: @default_headers.merge(headers), query: query, payload: payload)
+                    headers: @default_headers.merge(headers), query: query, payload: payload)
     end
 
-    ## CRUD method: POST
-    ##
-    ##
-    ## @return [Object]
-    ##
-    ## @see Crapi::Client#post Crapi::Client#post
-    ##
+    # CRUD method: POST
+    #
+    #
+    # @return [Object]
+    #
+    # @see CrAPI::Client#post CrAPI::Client#post
+    #
     def post(path, headers: {}, query: {}, payload: {})
       @parent.post("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
                    headers: @default_headers.merge(headers), query: query, payload: payload)
     end
 
-    ## CRUD method: PUT
-    ##
-    ##
-    ## @return [Object]
-    ##
-    ## @see Crapi::Client#put Crapi::Client#put
-    ##
+    # CRUD method: PUT
+    #
+    #
+    # @return [Object]
+    #
+    # @see CrAPI::Client#put CrAPI::Client#put
+    #
     def put(path, headers: {}, query: {}, payload: {})
       @parent.put("/#{@segment}/#{path}".gsub(%r{/+}, '/'),
                   headers: @default_headers.merge(headers), query: query, payload: payload)

data/lib/crapi/version.rb

@@ -1,11 +1,11 @@
-## The Crapi module houses the {Crapi::Client Crapi::Client} and {Crapi::Proxy Crapi::Proxy} classes
-## in this gem.
-##
-module Crapi
-  ## The canonical **crapi** gem version.
-  ##
-  ## This should only ever be updated *immediately* before a release; the commit that updates this
-  ## value should be pushed **by** the `rake release` process.
-  ##
-  VERSION = '0.1.3'.freeze
+# The CrAPI module houses the {CrAPI::Client CrAPI::Client} and {CrAPI::Proxy CrAPI::Proxy} classes
+# in this gem.
+#
+module CrAPI
+  # The canonical **crapi** gem version.
+  #
+  # This should only ever be updated *immediately* before a release; the commit that updates this
+  # value should be pushed **by** the `rake release` process.
+  #
+  VERSION = '1.0.1'.freeze
 end

data/lib/crapi.rb

@@ -2,5 +2,7 @@ require 'crapi/client'
 require 'crapi/proxy'
 require 'crapi/version'
 
-module Crapi
+# Parent module for the various CrAPI classes.
+#
+module CrAPI
 end

metadata

@@ -1,125 +1,129 @@
 --- !ruby/object:Gem::Specification
 name: crapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Nestor Custodio
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
-description: 
+        version: '0'
 email:
-- sakimorix@gmail.com
+- nestor@custodio.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - Gemfile.lock
@@ -129,12 +133,12 @@ files:
 - bin/console
 - bin/setup
 - crapi.gemspec
-- docs/Crapi.html
-- docs/Crapi/ArgumentError.html
-- docs/Crapi/BadHttpResponseError.html
-- docs/Crapi/Client.html
-- docs/Crapi/Error.html
-- docs/Crapi/Proxy.html
+- docs/CrAPI.html
+- docs/CrAPI/ArgumentError.html
+- docs/CrAPI/BadHttpResponseError.html
+- docs/CrAPI/Client.html
+- docs/CrAPI/Error.html
+- docs/CrAPI/Proxy.html
 - docs/Net/HTTP.html
 - docs/_index.html
 - docs/class_list.html
@@ -155,11 +159,11 @@ files:
 - lib/crapi/errors.rb
 - lib/crapi/proxy.rb
 - lib/crapi/version.rb
-homepage: https://www.github.com/nestor-custodio/crapi
+homepage: https://github.com/nestor-custodio/crapi
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -167,17 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: A simple API client with built-in segment/header proxy support. "... It could
-  be better." ™️
+summary: A simple API client with built-in segment/header proxy support.
 test_files: []

data/.travis.yml

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

data/docs/Crapi.html

@@ -1,153 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Crapi
-  
-    &mdash; Documentation by YARD 0.9.12
-  
-</title>
-
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
-  pathId = "Crapi";
-  relpath = '';
-</script>
-
-
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
-
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-  
-    <a href="_index.html">Index (C)</a> &raquo;
-    
-    
-    <span class="title">Crapi</span>
-  
-</div>
-
-        <div id="search">
-  
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-  
-</div>
-        <div class="clear"></div>
-      </div>
-
-      <div id="content"><h1>Module: Crapi
-  
-  
-  
-</h1>
-<div class="box_info">
-  
-
-  
-  
-  
-  
-  
-
-  
-
-  
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/crapi/version.rb<span class="defines">,<br />
-  lib/crapi.rb,<br /> lib/crapi/proxy.rb,<br /> lib/crapi/client.rb,<br /> lib/crapi/errors.rb</span>
-</dd>
-  </dl>
-  
-</div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    
-<p>The Crapi module houses the <span class='object_link'><a href="Crapi/Client.html" title="Crapi::Client (class)">Crapi::Client</a></span> and <span class='object_link'><a href="Crapi/Proxy.html" title="Crapi::Proxy (class)">Crapi::Proxy</a></span> classes in this gem.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><h2>Defined Under Namespace</h2>
-<p class="children">
-  
-    
-  
-    
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Crapi/ArgumentError.html" title="Crapi::ArgumentError (class)">ArgumentError</a></span>, <span class='object_link'><a href="Crapi/BadHttpResponseError.html" title="Crapi::BadHttpResponseError (class)">BadHttpResponseError</a></span>, <span class='object_link'><a href="Crapi/Client.html" title="Crapi::Client (class)">Client</a></span>, <span class='object_link'><a href="Crapi/Error.html" title="Crapi::Error (class)">Error</a></span>, <span class='object_link'><a href="Crapi/Proxy.html" title="Crapi::Proxy (class)">Proxy</a></span>
-    
-  
-</p>
-
-  <h2>Constant Summary</h2>
-  <dl class="constants">
-    
-      <dt id="VERSION-constant" class="">VERSION =
-        <div class="docstring">
-  <div class="discussion">
-    
-<p>The canonical <strong>crapi</strong> gem version.</p>
-
-<p>This should only ever be updated <em>immediately</em> before a release; the
-commit that updates this value should be pushed <strong>by</strong> the
-<code>rake release</code> process.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div>
-      </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.3</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
-    
-  </dl>
-
-
-
-
-
-
-
-
-
-</div>
-
-      <div id="footer">
-  Generated on Wed May 30 16:20:53 2018 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.5.1).
-</div>
-
-    </div>
-  </body>
-</html>