berkshelf-api-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ddfee1850c3e9011e1495158ad9be8755194118
+  data.tar.gz: 8b719703fae7941835d42a606b2e67f2d43ca9aa
+SHA512:
+  metadata.gz: a7e0ddf593d0e6c6835da51d51dcf1253eca1417b867ab7fd089c6998e929b61bcf623dde549de9e2e81fa74746d201d39738c044ccda1a68dca18b7672bf5c4
+  data.tar.gz: ada8bc1b336c3cb192ec51dd383054a2355c6044633a426e947ba87dccbbaed90e4008a2e165de86068f24887c086242644a2f2220139aa927cedabfbc27678b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,36 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :guard do
+  gem 'coolline',      '~> 0.4.2'
+  gem 'guard',         '~> 1.8'
+  gem 'guard-cucumber'
+  gem 'guard-rspec'
+  gem 'guard-spork'
+  gem 'guard-yard'
+
+  require 'rbconfig'
+
+  if RbConfig::CONFIG['target_os'] =~ /darwin/i
+    gem 'growl', require: false
+    gem 'rb-fsevent', require: false
+
+    if `uname`.strip == 'Darwin' && `sw_vers -productVersion`.strip >= '10.8'
+      gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+    end rescue Errno::ENOENT
+
+  elsif RbConfig::CONFIG['target_os'] =~ /linux/i
+    gem 'libnotify',  '~> 0.8.0', require: false
+    gem 'rb-inotify', require: false
+
+  elsif RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+    gem 'rb-notifu', '>= 0.0.4', require: false
+    gem 'wdm', require: false
+    gem 'win32console', require: false
+  end
+end
+
+group :test do
+  gem 'berkshelf-api', github: "berkshelf/berkshelf-api"
+end

data/Guardfile

@@ -0,0 +1,14 @@
+guard 'spork' do
+  watch('Gemfile')
+  watch('spec/spec_helper.rb')  { :rspec }
+end
+
+guard 'yard', stdout: '/dev/null', stderr: '/dev/null' do
+  watch(%r{lib/.+\.rb})
+end
+
+guard 'rspec', cli: '--color --drb --format Fuubar', all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013 Jamie Winsor
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+# Berkshelf::APIClient
+
+A Ruby library for communicating with the [Berkshelf API server](https://github.com/berkshelf/berkshelf-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'berkshelf-api-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install berkshelf-api-client
+
+## Usage
+
+    require 'berkshelf/api-client'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/berkshelf-api-client.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'berkshelf/api_client'
+
+Gem::Specification.new do |spec|
+  spec.name                      = "berkshelf-api-client"
+  spec.version                   = Berkshelf::APIClient::VERSION
+  spec.authors                   = [
+    "Jamie Winsor",
+    "Michael Ivey",
+    "Seth Vargo"
+  ]
+  spec.email                     = [
+    "jamie@vialstudios.com",
+    "michael.ivey@riotgames.com",
+    "sethvargo@gmail.com"
+  ]
+  spec.description               = %q{API Client for communicating with a Berkshelf API server}
+  spec.summary                   = spec.description
+  spec.homepage                  = "http://berkshelf.com"
+  spec.license                   = "Apache 2.0"
+  spec.required_ruby_version     = " >= 1.9.2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.8.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'fuubar',  "~> 1.1"
+  spec.add_development_dependency 'rspec',   "~> 2.13"
+  spec.add_development_dependency 'spork',   "~> 0.9"
+  spec.add_development_dependency 'yard',    "~> 0.8"
+end

data/lib/berkshelf/api-client.rb

@@ -0,0 +1 @@
+require_relative 'api_client'

data/lib/berkshelf/api_client.rb

@@ -0,0 +1,85 @@
+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"
+
+    require_relative 'api_client/errors'
+    require_relative 'api_client/remote_cookbook'
+
+    # @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

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

data/lib/berkshelf/api_client/remote_cookbook.rb

@@ -0,0 +1,55 @@
+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
+    end
+  end
+end

data/lib/berkshelf/api_client/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec'
+require 'spork'
+require 'berkshelf/api/rspec'
+
+Spork.prefork do
+  Dir[File.join(File.expand_path("../../spec/support/**/*.rb", __FILE__))].each { |f| require f }
+
+  RSpec.configure do |config|
+    config.include Berkshelf::API::RSpec
+
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+    config.mock_with :rspec
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.filter_run focus: true
+    config.run_all_when_everything_filtered = true
+
+    config.before(:suite) { Berkshelf::API::RSpec::Server.start }
+    config.before(:all) { Berkshelf::API::Logging.init(location: '/dev/null') }
+  end
+end
+
+Spork.each_run do
+  require 'berkshelf/api-client'
+end

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Berkshelf::APIClient::RemoteCookbook do
+  let(:name) { "ruby" }
+  let(:version) { "1.2.3" }
+  let(:dependencies) { double('dependencies') }
+  let(:platforms) { double('platforms') }
+  let(:location_type) { "chef_server" }
+  let(:location_path) { "http://localhost:8080" }
+
+  let(:attributes) do
+    { dependencies: dependencies, platforms: platforms, location_path: location_path, location_type: location_type }
+  end
+
+  subject { described_class.new(name, version, attributes) }
+
+  its(:name) { should eql(name) }
+  its(:version) { should eql(version) }
+  its(:dependencies) { should eql(dependencies) }
+  its(:platforms) { should eql(platforms) }
+  its(:location_type) { should eql(:chef_server) }
+  its(:location_path) { should eql(location_path) }
+end

data/spec/unit/berkshelf/api_client_spec.rb

@@ -0,0 +1,57 @@
+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
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: berkshelf-api-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jamie Winsor
+- Michael Ivey
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: API Client for communicating with a Berkshelf API server
+email:
+- jamie@vialstudios.com
+- michael.ivey@riotgames.com
+- sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- berkshelf-api-client.gemspec
+- lib/berkshelf/api-client.rb
+- lib/berkshelf/api_client.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/remote_cookbook_spec.rb
+- spec/unit/berkshelf/api_client_spec.rb
+homepage: http://berkshelf.com
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: API Client for communicating with a Berkshelf API server
+test_files:
+- spec/spec_helper.rb
+- spec/unit/berkshelf/api_client/remote_cookbook_spec.rb
+- spec/unit/berkshelf/api_client_spec.rb
+has_rdoc: