berkshelf-api-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ddfee1850c3e9011e1495158ad9be8755194118
-  data.tar.gz: 8b719703fae7941835d42a606b2e67f2d43ca9aa
+  metadata.gz: b24984684bc4e74fd8c9e4c74a96e7387075c235
+  data.tar.gz: 37fa9b61254d333c6b10abb5aff3638c807f09fa
 SHA512:
-  metadata.gz: a7e0ddf593d0e6c6835da51d51dcf1253eca1417b867ab7fd089c6998e929b61bcf623dde549de9e2e81fa74746d201d39738c044ccda1a68dca18b7672bf5c4
-  data.tar.gz: ada8bc1b336c3cb192ec51dd383054a2355c6044633a426e947ba87dccbbaed90e4008a2e165de86068f24887c086242644a2f2220139aa927cedabfbc27678b
+  metadata.gz: a2687d666f257c2ec25c9786f1f25e12fc8c5cbcec50717b09c4b2570975013ca5a5d77502e6d6c1ee196d992d98669cb2334b03915f9397e6738b6933e203f1
+  data.tar.gz: 3c210c34674982c6ec7411d2cdfb6520eae51349e711e8a81205bf64990cdef7af55860f1a31a8a01e1d343277152cf5253611e03fbebc32e87f087ca66e8522

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#berkshelf"
+    skip_join: true
+    use_notice: true
+script: bundle exec rake spec

data/README.md

@@ -1,4 +1,5 @@
 # Berkshelf::APIClient
+[![Build Status](https://travis-ci.org/berkshelf/berkshelf-api-client.png?branch=master)](https://travis-ci.org/berkshelf/berkshelf-api-client)
 
 A Ruby library for communicating with the [Berkshelf API server](https://github.com/berkshelf/berkshelf-api)
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/berkshelf-api-client.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'berkshelf/api_client'
+require 'berkshelf/api_client/version'
 
 Gem::Specification.new do |spec|
   spec.name                      = "berkshelf-api-client"

data/lib/berkshelf/api_client/connection.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+
+module Berkshelf::APIClient
+  class Connection < Faraday::Connection
+    # @return [String]
+    attr_reader :url
+
+    # @return [Integer]
+    #   how many retries to attempt on HTTP requests
+    attr_reader :retries
+
+    # @return [Float]
+    #   time to wait between retries
+    attr_reader :retry_interval
+
+    # @param [String, Addressable::URI] url
+    #
+    # @option options [Integer] :open_timeout (3)
+    #   how long to wait (in seconds) for connection open to the API server
+    # @option options [Integer] :timeout (30)
+    #   how long to wait (in seconds) before getting a response from the API server
+    # @option options [Integer] :retries (3)
+    #   how many retries to perform before giving up
+    # @option options [Float] :retry_interval (0.5)
+    #   how long to wait (in seconds) between each retry
+    def initialize(url, options = {})
+      options         = options.reverse_merge(retries: 3, retry_interval: 0.5,
+        open_timeout: 3, timeout: 30)
+      @url            = url
+      @retries        = options[:retries]
+      @retry_interval = options[:retry_interval]
+
+      options[:builder] ||= Faraday::Builder.new do |b|
+        b.response :parse_json
+        b.response :gzip
+        b.request :retry,
+          max: self.retries,
+          interval: self.retry_interval,
+          exceptions: [ Faraday::Error::TimeoutError, Errno::ETIMEDOUT ]
+
+        b.adapter :net_http
+      end
+
+      super(self.url, options)
+      @options[:open_timeout] = options[:open_timeout]
+      @options[:timeout]      = options[:timeout]
+    end
+
+    # Retrieves the entire universe of known cookbooks from the API source
+    #
+    # @raise [APIClient::TimeoutError]
+    #
+    # @return [Array<APIClient::RemoteCookbook>]
+    def universe
+      response = get("universe")
+
+      case response.status
+      when 200
+        [].tap do |cookbooks|
+          response.body.each do |name, versions|
+            versions.each { |version, attributes| cookbooks << RemoteCookbook.new(name, version, attributes) }
+          end
+        end
+      when 404
+        raise APIClient::ServiceNotFound, "service not found at: #{url}"
+      when 500..504
+        raise APIClient::ServiceUnavaiable, "service unavailable at: #{url}"
+      else
+        raise APIClient::BadResponse, "bad response #{response.inspect}"
+      end
+    rescue Faraday::Error::TimeoutError, Errno::ETIMEDOUT
+      raise APIClient::TimeoutError, "Unable to connect to: #{url}"
+    end
+  end
+end

data/lib/berkshelf/api_client/errors.rb

@@ -1,7 +1,7 @@
 module Berkshelf
   class APIClientError < StandardError; end
 
-  class APIClient
+  module APIClient
     class TimeoutError < APIClientError; end
     class BadResponse < APIClientError; end
     class ServiceUnavaiable < APIClientError; end

data/lib/berkshelf/api_client/remote_cookbook.rb

@@ -1,55 +1,53 @@
 require 'json'
 
-module Berkshelf
-  class APIClient
-    # A representation of cookbook metadata indexed by a Berkshelf API Server. Returned
-    # by sending messages to a {Berkshelf::APIClient} and used to download cookbooks
-    # indexed by the Berkshelf API Server.
-    class RemoteCookbook
-      # @return [String]
-      attr_reader :name
-      # @return [String]
-      attr_reader :version
-
-      # @param [String] name
-      # @param [String] version
-      # @param [Hash] attributes
-      def initialize(name, version, attributes = {})
-        @name       = name
-        @version    = version
-        @attributes = attributes
-      end
-
-      # @return [Hash]
-      def dependencies
-        @attributes[:dependencies]
-      end
-
-      # @return [Hash]
-      def platforms
-        @attributes[:platforms]
-      end
-
-      # @return [Symbol]
-      def location_type
-        @attributes[:location_type].to_sym
-      end
-
-      # @return [String]
-      def location_path
-        @attributes[:location_path]
-      end
-
-      def to_hash
-        {
-          name: name,
-          version: version
-        }
-      end
-
-      def to_json(options = {})
-        ::JSON.pretty_generate(to_hash, options)
-      end
+module Berkshelf::APIClient
+  # A representation of cookbook metadata indexed by a Berkshelf API Server. Returned
+  # by sending messages to a {Berkshelf::APIClient} and used to download cookbooks
+  # indexed by the Berkshelf API Server.
+  class RemoteCookbook
+    # @return [String]
+    attr_reader :name
+    # @return [String]
+    attr_reader :version
+
+    # @param [String] name
+    # @param [String] version
+    # @param [Hash] attributes
+    def initialize(name, version, attributes = {})
+      @name       = name
+      @version    = version
+      @attributes = attributes
+    end
+
+    # @return [Hash]
+    def dependencies
+      @attributes[:dependencies]
+    end
+
+    # @return [Hash]
+    def platforms
+      @attributes[:platforms]
+    end
+
+    # @return [Symbol]
+    def location_type
+      @attributes[:location_type].to_sym
+    end
+
+    # @return [String]
+    def location_path
+      @attributes[:location_path]
+    end
+
+    def to_hash
+      {
+        name: name,
+        version: version
+      }
+    end
+
+    def to_json(options = {})
+      ::JSON.pretty_generate(to_hash, options)
     end
   end
 end

data/lib/berkshelf/api_client/version.rb

@@ -1,5 +1,5 @@
 module Berkshelf
-  class APIClient
-    VERSION = "1.0.0.dev"
+  module APIClient
+    VERSION = "1.1.0"
   end
 end

data/lib/berkshelf/api_client.rb

@@ -1,85 +1,19 @@
-require 'faraday'
-
 module Berkshelf
   # Used to communicate with a remotely hosted [Berkshelf API Server](https://github.com/berkshelf/berkshelf-api).
   #
   # @example
   #   client = Berkshelf::APIClient.new("https://api.berkshelf.com")
   #   client.universe #=> [...]
-  class APIClient < Faraday::Connection
-    VERSION = "1.0.0"
-
+  module APIClient
+    require_relative 'api_client/version'
     require_relative 'api_client/errors'
     require_relative 'api_client/remote_cookbook'
+    require_relative 'api_client/connection'
 
-    # @return [String]
-    attr_reader :url
-
-    # @return [Integer]
-    #   how many retries to attempt on HTTP requests
-    attr_reader :retries
-
-    # @return [Float]
-    #   time to wait between retries
-    attr_reader :retry_interval
-
-    # @param [String, Addressable::URI] url
-    #
-    # @option options [Integer] :open_timeout (3)
-    #   how long to wait (in seconds) for connection open to the API server
-    # @option options [Integer] :timeout (30)
-    #   how long to wait (in seconds) before getting a response from the API server
-    # @option options [Integer] :retries (3)
-    #   how many retries to perform before giving up
-    # @option options [Float] :retry_interval (0.5)
-    #   how long to wait (in seconds) between each retry
-    def initialize(url, options = {})
-      options         = options.reverse_merge(retries: 3, retry_interval: 0.5,
-        open_timeout: 3, timeout: 30)
-      @url            = url
-      @retries        = options[:retries]
-      @retry_interval = options[:retry_interval]
-
-      options[:builder] ||= Faraday::Builder.new do |b|
-        b.response :parse_json
-        b.response :gzip
-        b.request :retry,
-          max: self.retries,
-          interval: self.retry_interval,
-          exceptions: [ Faraday::Error::TimeoutError, Errno::ETIMEDOUT ]
-
-        b.adapter :net_http
-      end
-
-      super(self.url, options)
-      @options[:open_timeout] = options[:open_timeout]
-      @options[:timeout]      = options[:timeout]
-    end
-
-    # Retrieves the entire universe of known cookbooks from the API source
-    #
-    # @raise [APIClient::TimeoutError]
-    #
-    # @return [Array<APIClient::RemoteCookbook>]
-    def universe
-      response = get("universe")
-
-      case response.status
-      when 200
-        [].tap do |cookbooks|
-          response.body.each do |name, versions|
-            versions.each { |version, attributes| cookbooks << RemoteCookbook.new(name, version, attributes) }
-          end
-        end
-      when 404
-        raise APIClient::ServiceNotFound, "service not found at: #{url}"
-      when 500..504
-        raise APIClient::ServiceUnavaiable, "service unavailable at: #{url}"
-      else
-        raise APIClient::BadResponse, "bad response #{response.inspect}"
+    class << self
+      def new(*args)
+        Connection.new(*args)
       end
-    rescue Faraday::Error::TimeoutError, Errno::ETIMEDOUT
-      raise APIClient::TimeoutError, "Unable to connect to: #{url}"
     end
   end
 end

data/spec/unit/berkshelf/api_client/connection_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Berkshelf::APIClient::Connection do
+  let(:instance) { described_class.new("http://localhost:26210") }
+
+  describe "#universe" do
+    before do
+      berks_dependency("ruby", "1.2.3", dependencies: { "build-essential" => ">= 1.2.2" })
+      berks_dependency("ruby", "2.0.0", dependencies: { "build-essential" => ">= 1.2.2" })
+      berks_dependency("elixir", "1.0.0", platforms: { "CentOS" => "6.0" })
+    end
+
+    subject { instance.universe }
+
+    it "returns an array of APIClient::RemoteCookbook" do
+      expect(subject).to be_a(Array)
+
+      subject.each do |remote|
+        expect(remote).to be_a(Berkshelf::APIClient::RemoteCookbook)
+      end
+    end
+
+    it "contains a item for each dependency" do
+      expect(subject).to have(3).items
+      expect(subject[0].name).to eql("ruby")
+      expect(subject[0].version).to eql("1.2.3")
+      expect(subject[1].name).to eql("ruby")
+      expect(subject[1].version).to eql("2.0.0")
+      expect(subject[2].name).to eql("elixir")
+      expect(subject[2].version).to eql("1.0.0")
+    end
+
+    it "has the dependencies for each" do
+      expect(subject[0].dependencies).to include("build-essential" => ">= 1.2.2")
+      expect(subject[1].dependencies).to include("build-essential" => ">= 1.2.2")
+      expect(subject[2].dependencies).to be_empty
+    end
+
+    it "has the platforms for each" do
+      expect(subject[0].platforms).to be_empty
+      expect(subject[1].platforms).to be_empty
+      expect(subject[2].platforms).to include("CentOS" => "= 6.0.0")
+    end
+
+    it "has a location_path for each" do
+      subject.each do |remote|
+        expect(remote.location_path).to_not be_nil
+      end
+    end
+
+    it "has a location_type for each" do
+      subject.each do |remote|
+        expect(remote.location_type).to_not be_nil
+      end
+    end
+  end
+end

data/spec/unit/berkshelf/api_client_spec.rb

@@ -1,57 +1,9 @@
 require 'spec_helper'
 
 describe Berkshelf::APIClient do
-  let(:instance) { described_class.new("http://localhost:26210") }
-
-  describe "#universe" do
-    before do
-      berks_dependency("ruby", "1.2.3", dependencies: { "build-essential" => ">= 1.2.2" })
-      berks_dependency("ruby", "2.0.0", dependencies: { "build-essential" => ">= 1.2.2" })
-      berks_dependency("elixir", "1.0.0", platforms: { "CentOS" => "6.0" })
-    end
-
-    subject { instance.universe }
-
-    it "returns an array of APIClient::RemoteCookbook" do
-      expect(subject).to be_a(Array)
-
-      subject.each do |remote|
-        expect(remote).to be_a(Berkshelf::APIClient::RemoteCookbook)
-      end
-    end
-
-    it "contains a item for each dependency" do
-      expect(subject).to have(3).items
-      expect(subject[0].name).to eql("ruby")
-      expect(subject[0].version).to eql("1.2.3")
-      expect(subject[1].name).to eql("ruby")
-      expect(subject[1].version).to eql("2.0.0")
-      expect(subject[2].name).to eql("elixir")
-      expect(subject[2].version).to eql("1.0.0")
-    end
-
-    it "has the dependencies for each" do
-      expect(subject[0].dependencies).to include("build-essential" => ">= 1.2.2")
-      expect(subject[1].dependencies).to include("build-essential" => ">= 1.2.2")
-      expect(subject[2].dependencies).to be_empty
-    end
-
-    it "has the platforms for each" do
-      expect(subject[0].platforms).to be_empty
-      expect(subject[1].platforms).to be_empty
-      expect(subject[2].platforms).to include("CentOS" => "= 6.0.0")
-    end
-
-    it "has a location_path for each" do
-      subject.each do |remote|
-        expect(remote.location_path).to_not be_nil
-      end
-    end
-
-    it "has a location_type for each" do
-      subject.each do |remote|
-        expect(remote.location_type).to_not be_nil
-      end
+  describe "::new" do
+    it "returns an instance of Berkshelf::APIClient::Connection" do
+      expect(described_class.new("http://localhost:26210")).to be_a(Berkshelf::APIClient::Connection)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf-api-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jamie Winsor
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -120,6 +120,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -128,10 +130,12 @@ files:
 - berkshelf-api-client.gemspec
 - lib/berkshelf/api-client.rb
 - lib/berkshelf/api_client.rb
+- lib/berkshelf/api_client/connection.rb
 - lib/berkshelf/api_client/errors.rb
 - lib/berkshelf/api_client/remote_cookbook.rb
 - lib/berkshelf/api_client/version.rb
 - spec/spec_helper.rb
+- spec/unit/berkshelf/api_client/connection_spec.rb
 - spec/unit/berkshelf/api_client/remote_cookbook_spec.rb
 - spec/unit/berkshelf/api_client_spec.rb
 homepage: http://berkshelf.com
@@ -160,6 +164,7 @@ specification_version: 4
 summary: API Client for communicating with a Berkshelf API server
 test_files:
 - spec/spec_helper.rb
+- spec/unit/berkshelf/api_client/connection_spec.rb
 - spec/unit/berkshelf/api_client/remote_cookbook_spec.rb
 - spec/unit/berkshelf/api_client_spec.rb
 has_rdoc: