crapi 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ffc82957409a8df0940450867c2a1325f21819f07fe90e8f3c50920fa5b18d3
-  data.tar.gz: bc596d700607f8409166acf07dcc88c30d21e49eb70b2fdf8758be868c70a3a1
+  metadata.gz: '075697a77cf82734a58523c8c65c8395d754ad3e7a0a41648a5d33228e62b77e'
+  data.tar.gz: c5368393dd38933dd3e10ee4bb23dfc809e5ab023dbdccfa50a882d23fdf41a6
 SHA512:
-  metadata.gz: 0ed50ee3802edc54336af81f71502b602960c7608ca2b540919ab8a9255c94f8fe77abe1e9ee28ac045ee864c47ce14dacf5bab068231050999bfa366b3c8ec1
-  data.tar.gz: f551f92822f103927b9c47387c2fbebf2bb1fc9f74a23ea5761aa8a127ac470c299e7c5fb7e817231518969083b960e524f346317870c9cfa5cde7f9672cbbfe
+  metadata.gz: 9340c8ec96dd620bcd6e41388af546e2adb5b01edc331209d2f541f6229e396caece559911bbbb16879d2cd53b1ca3bf2af5cf0dbfb28ed2b5525a2892a6408a
+  data.tar.gz: c72ae40ed2ca9b4bcaef675e4e8326dc33e4764b9c577a10fddfbdbc52653e4458f386e363f4c5d42e04c033eb8782ca5bef0071cfd2d67f65c208a028d6130e

data/.circleci/config.yml

@@ -0,0 +1,63 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: cimg/ruby:3.0
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies
+
+      - run:
+          name: update bundler
+          command: |
+            gem install bundler --version $(tail -n 1 ~/repo/Gemfile.lock | tr -d ' ')
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress                 \
+                              --format RspecJunitFormatter      \
+                              --out /tmp/test-results/rspec.xml \
+                              --format progress                 \
+                              --                                \
+                              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.rubocop.yml

@@ -1,81 +1,64 @@
 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.
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
+
+
+Layout/EmptyLineAfterGuardClause:
+  # Add empty line after guard clause.
   Enabled: false
-  Max: 100
+
+Layout/LineLength:
+  # Checks that line length does not exceed the configured limit.
+  Max: 150
+
+
+Metrics/AbcSize:
+  # A calculated magnitude based on number of assignments, branches, and conditions.
+  Max: 30
+
 Metrics/BlockLength:
+  # Avoid long blocks with many lines.
   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
+  # A complexity metric that is strongly correlated to the number of test cases needed to validate a method.
+  Max: 10
+
+Metrics/MethodLength:
+  # Avoid methods longer than 25 lines of code.
+  Max: 25
+
+
 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
+  # Use only ASCII symbols in comments.
+  #
+  # NLC: We're allowing non-breaking spaces (' '), as they're needed to prevent
+  #      browsers from collapsing multiple spaces in documentation code blocks.
+  AllowedChars:
+    - ' '
+
 Style/ClassAndModuleChildren:
-  Description: Use nested modules/class definitions instead of compact style.
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/EmptyMethod:
+  # Checks style of children classes and modules.
   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.
+
+Style/FetchEnvVar:
+  # Suggests `ENV.fetch` for the replacement of `ENV[]`.
   Enabled: false
-Naming/UncommunicativeMethodParamName:
-  Description: This cop checks method parameter names for how descriptive they are.
+
+Style/FrozenStringLiteralComment:
+  # Add the frozen_string_literal comment to the top of files to help transition to frozen string literals by default.
+  EnforcedStyle: never
+
+Style/NumericLiterals:
+  # Add underscores to large numeric literals to improve their readability.
   Enabled: false
+
+Style/RegexpLiteral:
+  # Use / or %r around regular expressions.
+  EnforcedStyle: percent_r
+
+Style/StringLiterals:
+  # Check for use of ' vs ".
+  ConsistentQuotesInMultiline: true

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.0

data/Gemfile.lock

@@ -1,62 +1,86 @@
 PATH
   remote: .
   specs:
-    crapi (0.1.2)
-      activesupport (~> 5.2.0)
+    crapi (0.1.3)
+      activesupport (>= 6.0, < 7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
+    activesupport (7.0.4)
       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)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
       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)
+    json (2.6.3)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rspec_junit_formatter (0.3.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2)
   crapi!
-  pry (~> 0.11)
-  pry-byebug (~> 3.6)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.3)
+  rspec (~> 3)
+  rspec_junit_formatter
+  rubocop
+  webmock
+  yard
 
 BUNDLED WITH
-   1.16.2
+   2.3.24

data/README.md

@@ -1,8 +1,13 @@
-# Crapi
+[![Gem Version](https://img.shields.io/github/v/release/nestor-custodio/crapi?color=green&label=gem%20version)](https://rubygems.org/gems/crapi)
+[![MIT License](https://img.shields.io/github/license/nestor-custodio/crapi)](https://tldrlegal.com/license/mit-license)
 
-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
+# CrAPI
+
+CrAPI is yet another <u>Cr</u>ud <u>API</u> client wrapper. Yes, there is no shortage of these out there, but no other API wrapper gem (that I could find) provided the kind of functionality you get from the CrAPI::Proxy class, which is really the biggest benefit here.
+
+**CrAPI::Client** will connect to the target system and handily provides a base path for you (because some APIs and services have a path that is always part of every request), **CrAPI::Proxy** lets you add to the root client's base path or default set of headers without having to create any new connections.
+
 
 ## Installation
 
@@ -20,20 +25,85 @@ Or install it yourself as:
 
     $ gem install crapi
 
-## Usage
 
-TODO: Write usage instructions here
+## Using The CrAPI Tools
+
+### Client Usage
+
+```ruby
+# Connect to an API.
+
+api = CrAPI::Client.new('https://jsonplaceholder.typicode.com/')
+
+
+# Issue requests against the API.
+
+api.get('users/1')  # GETs /users/1; returns a Hash.
+
+api.get('posts', query: { userId: 2 })  # GETs /posts?userId=2; returns an Array.
+
+mew_comment = { user: 'megapwner', text: 'FRIST!!1!' }
+api.post('comments', payload: new_comment)  # POSTs to /comments; returns a Hash.
+```
+
+---
+
+### Proxy Usage
+
+```ruby
+# Connect to an API.
+
+api = CrAPI::Client.new('https://versioned.fake-api.com/api/')
+
+
+# Back in the v1 days, versioning of this API was via the URL ...
+
+v1 = api.new_proxy('/v1')
+
+v1.get('data')  # GETs /api/v1/data; pretty straight-forward.
+v1.post('data', payload: values)  # POSTs *values* to /api/v1/data.
+
+
+# For API v2, they switched to an Accept header approach ...
+
+v2 = api.new_proxy('/', headers: { Accept: 'application/vnd.fake-api.v2+json' })
+
+v2.get('data')  # GETs /api/data with the v2 header.
+
+
+# API v3 keeps the Accept header approach ...
+
+v3 = api.new_proxy('/', headers: { Accept: 'application/vnd.fake-api.v3+json' })
+
+v3.get('data')  # GETs /api/data with the v3 header.
+
+
+# Note that only one connection to the client is made and you can easily make
+# v1, v2, and v3 API calls ad hoc without having to juggle paths/headers yourself.
+```
+
+---
+
+[Consult the repo docs for the full CrAPI documentation.](http://nestor-custodio.github.io/crapi/CrAPI.html)
+
+
+## Feature Roadmap / Future Development
+
+Additional features/options coming in the future:
+
+- Cleaner handling of non-body-returning calls.
+- More resilient serializing of non-String paylods when using custom Content-Type headers.
+
 
-## Development
+## Contribution / 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.
+Bug reports and pull requests are welcome at: [https://github.com/nestor-custodio/crapi](https://github.com/nestor-custodio/crapi)
 
-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).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-## Contributing
+Linting is courtesy of [Rubocop](https://docs.rubocop.org/) (`bundle exec rubocop`) and documentation is built using [Yard](https://yardoc.org/) (`bundle exec yard`). Please ensure you have a clean bill of health from Rubocop and that any new features and/or changes to behaviour are reflected in the documentation before submitting a pull request.
 
-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).
+CrAPI is available as open source under the terms of the [MIT License](https://tldrlegal.com/license/mit-license).

data/crapi.gemspec

@@ -1,31 +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.required_ruby_version = ['>= 3.0', '< 3.2']
+
   spec.name          = 'crapi'
-  spec.version       = Crapi::VERSION
+  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.homepage      = 'https://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.files         = `git ls-files -z`.split("\x0").reject { |filename| filename.start_with? 'test/' }
+  spec.executables   = []
   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.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'activesupport', ['>= 6.0', '< 7.1']
 
-  spec.add_dependency 'activesupport', '~> 5.2.0'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 end

data/docs/CrAPI/ArgumentError.html

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: CrAPI::ArgumentError
+  
+    &mdash; Documentation by YARD 0.9.28
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "CrAPI::ArgumentError";
+  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 (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../CrAPI.html" title="CrAPI (module)">CrAPI</a></span></span>
+     &raquo; 
+    <span class="title">ArgumentError</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>Exception: CrAPI::ArgumentError
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Error.html" title="CrAPI::Error (class)">Error</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next"><span class='object_link'><a href="Error.html" title="CrAPI::Error (class)">Error</a></span></li>
+          
+            <li class="next">CrAPI::ArgumentError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/crapi/errors.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>An error relating to missing, invalid, or incompatible method arguments.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+  
+  
+  
+  
+  
+  
+  
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Jan  2 15:16:45 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.28 (ruby-3.0.4).
+</div>
+
+    </div>
+  </body>
+</html>