crapi 0.1.3 → 1.0.0

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.0'.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

data/spec/crapi_client_spec.rb

@@ -0,0 +1,121 @@
+RSpec.describe CrAPI::Client do
+  subject do
+    client = CrAPI::Client.new API_DOMAIN
+    client.default_headers.merge! client: '1'
+
+    client
+  end
+
+  let(:payload_hash) { { string_value: 'abc', numeric_value: 123, a_list: %w[one two three] } }
+  let(:payload_json) { JSON.generate payload_hash }
+
+  let(:empty_response_spec) { { status: 204, body: nil } }
+  let(:payload_response_spec) { { status: 200, headers: { 'content-type': 'application/json' }, body: payload_json } }
+
+  def stub(method, uri, headers: {})
+    stub_request(method, "#{API_DOMAIN}/#{uri.delete_prefix '/'}").with(headers: full_request_headers(headers))
+  end
+
+  def full_request_headers(custom_values = {})
+    subject.default_headers.merge custom_values
+  end
+
+  def crud_header_test(method, with_header:)
+    uri = '/resource/1'
+
+    if with_header
+      unique_header = { 'X-Test' => SecureRandom.hex }
+      stub(method, uri, headers: unique_header).to_return(status: 204)
+      expect { subject.send(method, uri, headers: unique_header) }.not_to raise_error
+    else
+      stub(method, uri).to_return(status: 204)
+      expect { subject.send(method, uri) }.not_to raise_error
+    end
+  end
+
+  def crud_parsing_test(method, with_body:)
+    uri = '/resource/1'
+
+    if with_body
+      stub(method, uri).to_return(payload_response_spec)
+      expect(subject.send(method, uri)).to eq(payload_hash)
+    else
+      stub(method, uri).to_return(empty_response_spec)
+      expect(subject.send(method, uri)).to eq(nil)
+    end
+  end
+
+  # ---
+
+  describe '#new_proxy' do
+    it('is defined') { is_expected.to respond_to :new_proxy }
+    it('returns a CrAPI::Proxy') { expect(subject.new_proxy).to be_a(CrAPI::Proxy) }
+  end
+
+  # ---
+
+  describe '#delete' do
+    let(:method) { :delete }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+  end
+
+  describe '#get' do
+    let(:method) { :get }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#patch' do
+    let(:method) { :patch }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#post' do
+    let(:method) { :post }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#put' do
+    let(:method) { :put }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+end

data/spec/crapi_errors_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe CrAPI::Error do
+  it 'is defined' do
+    expect(defined? CrAPI::Error).not_to be(nil)
+  end
+
+  describe 'is subclassed as ...' do
+    it 'CrAPI::ArgumentError' do
+      expect(defined? CrAPI::ArgumentError).not_to be(nil)
+      expect(CrAPI::ArgumentError.superclass).to be(CrAPI::Error)
+    end
+
+    it 'CrAPI::BadHttpResponseError' do
+      expect(defined? CrAPI::BadHttpResponseError).not_to be(nil)
+      expect(CrAPI::BadHttpResponseError.superclass).to be(CrAPI::Error)
+    end
+  end
+end

data/spec/crapi_proxy_spec.rb

@@ -0,0 +1,121 @@
+RSpec.describe CrAPI::Proxy do
+  subject do
+    client = CrAPI::Client.new API_DOMAIN
+    client.default_headers.merge! client: '1'
+
+    client.new_proxy '/proxy_path', headers: { client: '0', proxy: '1' }
+  end
+
+  let(:payload_hash) { { string_value: 'abc', numeric_value: 123, a_list: %w[one two three] } }
+  let(:payload_json) { JSON.generate payload_hash }
+
+  let(:empty_response_spec) { { status: 204, body: nil } }
+  let(:payload_response_spec) { { status: 200, headers: { 'content-type': 'application/json' }, body: payload_json } }
+
+  def stub(method, uri, headers: {})
+    stub_request(method, "#{API_DOMAIN}/proxy_path/#{uri.delete_prefix '/'}").with(headers: full_request_headers(headers))
+  end
+
+  def full_request_headers(custom_values = {})
+    subject.default_headers.merge custom_values
+  end
+
+  def crud_header_test(method, with_header:)
+    uri = '/resource/1'
+
+    if with_header
+      unique_header = { 'X-Test' => SecureRandom.hex }
+      stub(method, uri, headers: unique_header).to_return(status: 204)
+      expect { subject.send(method, uri, headers: unique_header) }.not_to raise_error
+    else
+      stub(method, uri).to_return(status: 204)
+      expect { subject.send(method, uri) }.not_to raise_error
+    end
+  end
+
+  def crud_parsing_test(method, with_body:)
+    uri = '/resource/1'
+
+    if with_body
+      stub(method, uri).to_return(payload_response_spec)
+      expect(subject.send(method, uri)).to eq(payload_hash)
+    else
+      stub(method, uri).to_return(empty_response_spec)
+      expect(subject.send(method, uri)).to eq(nil)
+    end
+  end
+
+  # ---
+
+  describe '#new_proxy' do
+    it('is defined') { is_expected.to respond_to :new_proxy }
+    it('returns a CrAPI::Proxy') { expect(subject.new_proxy).to be_a(CrAPI::Proxy) }
+  end
+
+  # ---
+
+  describe '#delete' do
+    let(:method) { :delete }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+  end
+
+  describe '#get' do
+    let(:method) { :get }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#patch' do
+    let(:method) { :patch }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#post' do
+    let(:method) { :post }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+
+  describe '#put' do
+    let(:method) { :put }
+
+    describe 'sends correctly' do
+      it('w/ headers') { crud_header_test(method, with_header: true) }
+      it('w/o headers') { crud_header_test(method, with_header: false) }
+    end
+
+    describe 'parses responses' do
+      it('w/ response body') { crud_parsing_test(method, with_body: true) }
+      it('w/o response body') { crud_parsing_test(method, with_body: false) }
+    end
+  end
+end

data/spec/crapi_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe CrAPI do
+  it 'has a version number' do
+    expect(CrAPI::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'crapi'
+require 'json'
+require 'securerandom'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  API_DOMAIN = 'https://fake-domain.lol'.freeze
+end