vertebrae 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62eabfcd0080454194f02c772758fcac1dee7998c264813b715f729c01f6deec
-  data.tar.gz: 563e98c3ad61dc9040cc26134d795eb884d535197963d736f7a76e121f66d29f
+  metadata.gz: 12abd176ae617d57fb896828dc31331db3e1d0fad69afbfae446096e2347f409
+  data.tar.gz: eef8c6ef2349430d071ba10c66797f2d1c73094a224da831a4c20fe1cf6d5b21
 SHA512:
-  metadata.gz: 703b18a9b5ffa5b538a43ef6c68caa99d22c34411a75fca19bce78e020183811d3e9f4bb5b1708d365928f8b7fec8402325affea87491807b955ab5f38572355
-  data.tar.gz: 59266d8c1051b15946274669008e702eafb08896a089a3f08eb6498d35b65d6a5ace24c3a72177d499a91a5fcac3be727b4a7a75d446020913537b2663eea7e4
+  metadata.gz: 9ce84790ba0a4982e968146a50295aa97265bc160a0358127ebabb09ff0aaa21b4eb21f005435393d1637feebc26a26a3862d3dc23eb983cbd64305e1da9ffae
+  data.tar.gz: 899944270224b32549f430c66f09ae5a30d460e0557c01148947a3273656f2b199ade90fefd7e11af292b05c39f83c0d523ebd861870f199f5e458db1e59adf5

data/.gitignore

@@ -0,0 +1,26 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# For MacOS:
+#
+.DS_Store
+.idea
+
+# For TextMate
+*.tmproj
+tmtags

data/lib/{connection.rb → vertebrae/connection.rb}

@@ -3,8 +3,8 @@
 require 'faraday'
 require 'faraday/multipart'
 require 'faraday/mashify'
-require 'response/raise_error'
-require 'authorization'
+require 'vertebrae/response/raise_error'
+require 'vertebrae/authorization'
 
 module Vertebrae
   class Connection

data/lib/vertebrae/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vertebrae
+  VERSION = '1.0.1'
+end

data/lib/vertebrae.rb

@@ -2,16 +2,16 @@
 
 require 'active_support/all'
 
-require 'constants'
-require 'authorization'
-require 'configuration'
-require 'connection'
-require 'request'
-require 'response_error'
-require 'api'
-require 'base'
-require 'model'
-require 'version'
+require 'vertebrae/constants'
+require 'vertebrae/authorization'
+require 'vertebrae/configuration'
+require 'vertebrae/connection'
+require 'vertebrae/request'
+require 'vertebrae/response_error'
+require 'vertebrae/api'
+require 'vertebrae/base'
+require 'vertebrae/model'
+require 'vertebrae/version'
 
 require 'railties' if defined? Rails
 

data/vertebrae.gemspec

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+require 'vertebrae/version'
 
 Gem::Specification.new do |s|
   s.name = "vertebrae".freeze
@@ -18,40 +18,13 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    ".document",
-    ".github/workflows/ci.yml",
-    ".rspec",
-    ".rubocop.yml",
-    ".ruby-gemset",
-    ".ruby-version",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/api.rb",
-    "lib/authorization.rb",
-    "lib/base.rb",
-    "lib/configuration.rb",
-    "lib/connection.rb",
-    "lib/constants.rb",
-    "lib/core_ext/array.rb",
-    "lib/model.rb",
-    "lib/railties.rb",
-    "lib/request.rb",
-    "lib/response/raise_error.rb",
-    "lib/response_error.rb",
-    "lib/vertebrae.rb",
-    "spec/api_spec.rb",
-    "spec/configuration_spec.rb",
-    "spec/dummy/client.rb",
-    "spec/dummy/dummy.rb",
-    "spec/logger_spec.rb",
-    "spec/request_spec.rb",
-    "spec/spec_helper.rb",
-    "vertebrae.gemspec"
-  ]
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
   s.homepage = "http://github.com/controlshift/vertebrae".freeze
   s.licenses = ["MIT".freeze]
   s.summary = "API Client Infrastructure".freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vertebrae
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Woodhull
@@ -161,6 +161,7 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".github/workflows/ci.yml"
+- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
@@ -170,26 +171,20 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- lib/api.rb
-- lib/authorization.rb
-- lib/base.rb
-- lib/configuration.rb
-- lib/connection.rb
-- lib/constants.rb
 - lib/core_ext/array.rb
-- lib/model.rb
-- lib/railties.rb
-- lib/request.rb
-- lib/response/raise_error.rb
-- lib/response_error.rb
 - lib/vertebrae.rb
-- spec/api_spec.rb
-- spec/configuration_spec.rb
-- spec/dummy/client.rb
-- spec/dummy/dummy.rb
-- spec/logger_spec.rb
-- spec/request_spec.rb
-- spec/spec_helper.rb
+- lib/vertebrae/api.rb
+- lib/vertebrae/authorization.rb
+- lib/vertebrae/base.rb
+- lib/vertebrae/configuration.rb
+- lib/vertebrae/connection.rb
+- lib/vertebrae/constants.rb
+- lib/vertebrae/model.rb
+- lib/vertebrae/railties.rb
+- lib/vertebrae/request.rb
+- lib/vertebrae/response/raise_error.rb
+- lib/vertebrae/response_error.rb
+- lib/vertebrae/version.rb
 - vertebrae.gemspec
 homepage: http://github.com/controlshift/vertebrae
 licenses:
@@ -210,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: API Client Infrastructure

data/spec/api_spec.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Vertebrae::API do
-  subject { described_class.new(options) }
-
-  it { expect(described_class.included_modules).to include Vertebrae::Request }
-
-  describe 'initialize' do
-    before(:each) do
-      allow_any_instance_of(Vertebrae::API).to receive(:default_options).and_return({content_type: 'foo'})
-    end
-
-    context 'with an empty hash' do
-      let(:options) { {} }
-      specify { expect(subject.connection.options).to eq({content_type: 'foo'}) }
-    end
-
-    context 'with a default content-type' do
-      let(:options) { {content_type: 'text/csv'} }
-      specify { expect(subject.connection.options).to eq({content_type: 'text/csv'}) }
-    end
-  end
-
-  describe 'dummy' do
-    describe 'should delegate to the client class' do
-      specify { expect(Dummy.new).to respond_to(:api)  }
-      specify { expect(Dummy).to respond_to(:api) }
-    end
-  end
-end

data/spec/configuration_spec.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Vertebrae::Configuration do
-
-  subject { Vertebrae::Configuration.new({}) }
-
-  {:scheme => described_class::DEFAULT_SCHEME,
-   :ssl => described_class::DEFAULT_SSL,
-   :user_agent => described_class::DEFAULT_USER_AGENT,
-   :username => described_class::DEFAULT_USERNAME,
-   :password => described_class::DEFAULT_PASSWORD }.each do | key, value |
-      its(key) { should == value }
-      its("default_#{key}") { should == value }
-  end
-
-  its(:connection_options) { should be_a Hash }
-  its(:connection_options) { should be_empty }
-
-  describe "override" do
-    subject{ Vertebrae::Configuration.new({username: 'foo', password: 'bar', scheme: 'http'}) }
-
-    its(:default_scheme) { should == described_class::DEFAULT_SCHEME }
-    its(:default_username) { should == described_class::DEFAULT_USERNAME }
-    its(:default_password) { should == described_class::DEFAULT_PASSWORD }
-
-    its(:scheme) { should == 'http'}
-    its(:username) { should == 'foo'}
-    its(:password) { should == 'bar'}
-  end
-
-  describe "setter" do
-    before(:each) do
-      subject.username =  'foo'
-    end
-    its(:username) { should == 'foo'}
-    its(:default_username) { should == described_class::DEFAULT_USERNAME }
-  end
-
-  describe 'endpoint' do
-    context 'with no port specification' do
-      subject { Vertebrae::Configuration.new({host: 'test.com', prefix: ''}) }
-
-      specify { expect(subject.host).to eq('test.com') }
-      specify { expect(subject.endpoint).to eq('https://test.com')}
-    end
-
-    context 'with port specification' do
-      subject { Vertebrae::Configuration.new({host: 'test.com', prefix: '', port: 8080}) }
-
-      specify { expect(subject.port).to eq(8080) }
-      specify { expect(subject.endpoint).to eq('https://test.com:8080')}
-
-      context 'with prefix' do
-        subject { Vertebrae::Configuration.new({host: 'test.com', prefix: '/api/v1', port: 8080}) }
-
-        specify { expect(subject.prefix).to eq('/api/v1') }
-        specify { expect(subject.endpoint).to eq('https://test.com:8080/api/v1')}
-      end
-    end
-  end
-
-  describe 'adapter' do
-    it 'should default to :net_http' do
-      expect(subject.adapter).to eq(:net_http)
-    end
-  end
-
-  describe 'adapter=' do
-    it 'should allow setting and retrieval' do
-      subject.adapter = :foo
-      expect(subject.adapter).to eq(:foo)
-    end
-  end
-
-  describe '#faraday_options' do
-    subject { Vertebrae::Configuration.new(host: 'example.com') }
-
-    it 'should include headers, ssl, and url settings by default' do
-      opts = subject.faraday_options
-      expect(opts.keys).to contain_exactly(:headers, :ssl, :url)
-      expect(opts[:headers]).to eq({'Accept' => 'application/json;q=0.1',
-                                    'Accept-Charset' => 'utf-8',
-                                    'User-Agent' => 'Vertebrae REST Gem',
-                                    'Content-Type' => 'application/json'})
-      expect(opts[:ssl]).to eq({})
-      expect(opts[:url]).to eq 'https://example.com/'
-    end
-
-    context 'with connection_options' do
-      let(:connection_options) { {ssl: {verify: false},
-                                  timeout: 5} }
-
-      subject { Vertebrae::Configuration.new(host: 'example.com', connection_options: connection_options) }
-
-      it 'should override and extend the default options' do
-        opts = subject.faraday_options
-        expect(opts.keys).to contain_exactly(:headers, :ssl, :timeout, :url)
-        expect(opts[:headers]).to eq({'Accept' => 'application/json;q=0.1',
-                                      'Accept-Charset' => 'utf-8',
-                                      'User-Agent' => 'Vertebrae REST Gem',
-                                      'Content-Type' => 'application/json'})
-        expect(opts[:ssl]).to eq({verify: false})
-        expect(opts[:url]).to eq 'https://example.com/'
-        expect(opts[:timeout]).to eq 5
-      end
-    end
-
-    context 'with additional_headers' do
-      let(:additional_headers) { {'special-auth-token' => 'abcde12345'} }
-
-      subject { Vertebrae::Configuration.new(host: 'example.com', additional_headers: additional_headers) }
-
-      it 'should add the additional headers to the other headers' do
-        opts = subject.faraday_options
-        expect(opts.keys).to contain_exactly(:headers, :ssl, :url)
-        expect(opts[:headers]).to eq({'Accept' => 'application/json;q=0.1',
-                                      'Accept-Charset' => 'utf-8',
-                                      'User-Agent' => 'Vertebrae REST Gem',
-                                      'Content-Type' => 'application/json',
-                                      'special-auth-token' => 'abcde12345'})
-        expect(opts[:ssl]).to eq({})
-        expect(opts[:url]).to eq 'https://example.com/'
-      end
-    end
-  end
-end

data/spec/dummy/client.rb

@@ -1,7 +0,0 @@
-module Dummy
-  class Client < Vertebrae::API
-    def api(options={}, &block)
-      @api ||= Vertebrae::API.new(current_options.merge(options), &block)
-    end
-  end
-end

data/spec/dummy/dummy.rb

@@ -1,8 +0,0 @@
-module Dummy
-  extend Vertebrae::Base
-  class << self
-    def new(options = {}, &block)
-      Dummy::Client.new(options, &block)
-    end
-  end
-end

data/spec/logger_spec.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'logging' do
-  it "should have a logger" do
-    expect(Dummy).to respond_to(:logger)
-  end
-
-  it "should be able to log debug methods" do
-    expect(Dummy.logger).to respond_to(:debug)
-  end
-
-  it "should be settable" do
-    expect(Dummy).to respond_to(:logger=)
-    log = double
-    Dummy.logger = log
-    expect(Dummy.logger).to eq(log)
-  end
-end

data/spec/request_spec.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Vertebrae::Request do
-  let(:vb) { Vertebrae::API.new  }
-  let(:path) { 'actionkit.api/rest/v1/action' }
-  let(:params) { {} }
-  let(:options) { {} }
-
-  it "knows how to make get request" do
-    expect(vb).to receive(:request).with(:get, path, params, options)
-    vb.get_request path, params, options
-  end
-
-  it "knows how to make patch request" do
-    expect(vb).to receive(:request).with(:patch, path, params, options)
-    vb.patch_request path, params, options
-  end
-
-  it "knows how to make post request" do
-    expect(vb).to receive(:request).with(:post, path, params, options)
-    vb.post_request path, params, options
-  end
-
-  it "knows how to make put request" do
-    expect(vb).to receive(:request).with(:put, path, params, options)
-    vb.put_request path, params, options
-  end
-
-  it "knows how to make delete request" do
-    vb.should_receive(:request).with(:delete, path, params, options)
-    vb.delete_request path, params, options
-  end
-
-  describe 'it should result in an appropriately configured connection object when it comes time to run transactions' do
-    before(:each) do
-      logger = double
-      logger.stub(:debug).and_return(true)
-      allow(Vertebrae::Base).to receive(:logger).and_return(logger)
-      allow_any_instance_of(Vertebrae::API).to receive(:default_options).and_return({host: 'test.com'})
-    end
-
-    context 'with an empty hash' do
-      let(:options) { {} }
-      it 'should make the request to the default host' do
-        stub_request(:get, 'https://test.com/path')
-        vb.request(:get, '/path', {}, options)
-      end
-    end
-
-    context 'with a different host' do
-      let(:options) { {host: 'test2.com'} }
-      it 'should make the request to the default host' do
-        stub_request(:get, 'https://test2.com/path')
-        vb.request(:get, '/path', {}, options)
-      end
-    end
-
-    context 'with host specified at client initiation time' do
-      let(:options) { {} }
-
-      let(:vb) { Vertebrae::API.new host: 'test3.com' }
-
-      it 'should make the request to the default host' do
-        stub_request(:get, 'https://test3.com/path')
-        vb.request(:get, '/path', {}, options)
-      end
-
-      context 'with a different host' do
-        let(:options) { {host: 'test2.com'} }
-        it 'should make the request to the default host' do
-          stub_request(:get, 'https://test2.com/path')
-          vb.request(:get, '/path', {}, options)
-        end
-      end
-    end
-
-    context 'with basic auth' do
-      let(:options) { {} }
-      let(:vb) { Vertebrae::API.new username: 'user', password: 'pass' }
-
-      it 'should make requests with basic auth' do
-        stub_request(:get, 'https://test3.com/path').with(basic_auth: %w[user pass])
-        vb.request(:get, '/path', {}, {host: 'test3.com'})
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'vertebrae'
-require 'dummy/dummy'
-require 'dummy/client'
-require 'webmock/rspec'
-
-require 'rspec/its'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each {|f| require f}
-
-RSpec.configure do |config|
-  config.mock_with :rspec do |mocks|
-    mocks.syntax = [:should, :expect]
-  end
-
-  config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
-  end
-end
-
-
-def reset_authentication_for(object)
-  %w[username password].each do |item|
-    Vertebrae::Base.send("#{item}=", nil)
-    object.send("#{item}=", nil)
-  end
-end