atlas 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eebf961af024f87de6faedfb7f592f13b8ad5ea
-  data.tar.gz: 755a43b75e08141b216475e5c53897680e796ab3
+  metadata.gz: bfcc9c5fb98681ad07faaaf69d275418c22b1ea4
+  data.tar.gz: 55823eb3defae3a970ceb99b298e636fb90cd2b0
 SHA512:
-  metadata.gz: d353c63963a831696d233bc00072a9a9d9ae7a12d8822db21fccb757f99a3600c28c486d45bcd5e1aec9ba5bd61a8a8ff7315ae50a1639978bc4f843ca34701f
-  data.tar.gz: 7de936672cd7500bf5f27935781a10f7a86ab906685171aa892d62d3074d1cbfce47b2c2e1d8b9bf4a069da53f17839a88d4c0a9253d1fd576da53abd6f05b5f
+  metadata.gz: b04a692cdba04c4b6f6bf5986acd7840eadd74493a696d777af8377ee57a3e3b20d2e558ce0e908653a6f74740ee60b11cb6ed9335210839e6dd183b3c898913
+  data.tar.gz: ae9887e9120916d97b94404523dbbb9c7db8340168a483afca4be1244f8a403c1253a78f8fa1659f323247f64039298f7a25fdee598d0c70951318d0dbf411ee

data/.codeclimate.yml

@@ -0,0 +1,13 @@
+---
+languages:
+  Ruby: true
+engines:
+  rubocop:
+    enabled: true
+  bundler-audit:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # CHANGELOG
 
-## 1.1.0
+## 1.2.0 (29/07/2015)
+
+* Adds custom error classes and catching in the request.
+* Moves the JSON response parsing into the request, removing from the
+  resources.
+
+## 1.1.0 (27/07/2015)
 
 * Adds support for uploading boxes to providers.
 * Adds shorter methods to create versions from boxes, and providers from
   versions.
 
-## 1.0.0
+## 1.0.0 (24/07/2015)
 
 * Initial release; handles creating, updating, deleting boxes, versions and
   providers.

data/README.md

@@ -35,13 +35,26 @@ end
 # then you can load in users (creating, updating, etc isn't supported by Atlas)
 user = Atlas::User.find('nickcharlton')
 #=> <Atlas::User username=nickcharlton...>
+```
+
+More likely, you'll want to grab a box and work with it:
 
-# or access boxes, their versions and providers
+```ruby
 box = Atlas::Box.find('nickcharlton/example-box')
 #=> <Atlas::Box name=example-box'...>
 
-# or create a new version
-version = box.create(version: '1.0.0', description: 'A new box version.')
+# creating a new version
+version = box.create_version(version: '1.0.0')
+#=> <Atlas::BoxVersion version: '1.0.0')
+
+# add a provider to that version
+provider = version.create_provider(name: 'virtualbox')
+
+# upload a file for the version
+provider.upload(File.open('box_name.box'))
+
+# set the version to be released
+version.release
 ```
 
 It aims to support most of the functionality listed in the [Atlas API

data/Rakefile

@@ -16,6 +16,15 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
+##
+# RuboCop
+##
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
 ##
 # By default, just run the tests.
 ##

data/atlas.gemspec

@@ -26,5 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'vcr', '~> 2.9'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.32'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.3'
   spec.add_development_dependency 'pry'
 end

data/lib/atlas.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'atlas/version'
 require 'atlas/configuration'
 require 'atlas/url_builder'
+require 'atlas/errors'
 require 'atlas/client'
 require 'atlas/resource'
 require 'atlas/box_provider'

data/lib/atlas/box.rb

@@ -22,7 +22,7 @@ module Atlas
       url_builder = UrlBuilder.new tag
       response = Atlas.client.get(url_builder.box_url)
 
-      new(tag, JSON.parse(response.body))
+      new(tag, response)
     end
 
     # Create a new Box.
@@ -113,23 +113,21 @@ module Atlas
       # update or create the box
       begin
         response = Atlas.client.put(url_builder.box_url, body: body)
-      rescue Excon::Errors::NotFound
+      rescue Atlas::Errors::NotFoundError
         response = Atlas.client.post('/boxes', body: body)
       end
 
       # trigger the same on versions
       versions.each(&:save) if versions
 
-      update_with_response(response.body, [:versions])
+      update_with_response(response, [:versions])
     end
 
     # Delete the box.
     #
     # @return [Hash] response body from Atlas.
     def delete
-      response = Atlas.client.delete(url_builder.box_url)
-
-      JSON.parse(response.body)
+      Atlas.client.delete(url_builder.box_url)
     end
   end
 end

data/lib/atlas/box_provider.rb

@@ -15,7 +15,7 @@ module Atlas
       url_builder = UrlBuilder.new tag
       response = Atlas.client.get(url_builder.box_provider_url)
 
-      new(tag, JSON.parse(response.body))
+      new(tag, response)
     end
 
     # Create a new Provider.
@@ -55,12 +55,12 @@ module Atlas
 
       begin
         response = Atlas.client.put(url_builder.box_provider_url, body: body)
-      rescue Excon::Errors::NotFound
+      rescue Atlas::Errors::NotFoundError
         response = Atlas.client.post("#{url_builder.box_version_url}/providers",
                                      body: body)
       end
 
-      update_with_response(response.body)
+      update_with_response(response)
     end
 
     # Upload a .box file for this provider.
@@ -71,7 +71,7 @@ module Atlas
       response = Atlas.client.get("#{url_builder.box_provider_url}/upload")
 
       # upload the file
-      upload_url = JSON.parse(response.body)['upload_path']
+      upload_url = response['upload_path']
       Excon.put(upload_url, body: file)
     end
 
@@ -79,9 +79,7 @@ module Atlas
     #
     # @return [Hash] Atlas response object.
     def delete
-      response = Atlas.client.delete(url_builder.box_provider_url)
-
-      JSON.parse(response.body)
+      Atlas.client.delete(url_builder.box_provider_url)
     end
   end
 end

data/lib/atlas/box_version.rb

@@ -20,7 +20,7 @@ module Atlas
       url_builder = UrlBuilder.new tag
       response = Atlas.client.get(url_builder.box_version_url)
 
-      new(tag, JSON.parse(response.body))
+      new(tag, response)
     end
 
     # Create a new version.
@@ -74,7 +74,7 @@ module Atlas
     # Save the version.
     #
     # @return [Hash] Atlas response object.
-    def save # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def save # rubocop:disable Metrics/AbcSize
       body = { version: to_hash }
 
       # providers are saved seperately
@@ -82,7 +82,7 @@ module Atlas
 
       begin
         response = Atlas.client.put(url_builder.box_version_url, body: body)
-      rescue Excon::Errors::NotFound
+      rescue Atlas::Errors::NotFoundError
         response = Atlas.client.post("#{url_builder.box_url}/versions",
                                      body: body)
       end
@@ -90,7 +90,7 @@ module Atlas
       # trigger the same on the providers
       providers.each(&:save) if providers
 
-      update_with_response(response.body, [:providers])
+      update_with_response(response, [:providers])
     end
 
     # Release the version.
@@ -99,7 +99,7 @@ module Atlas
     def release
       response = Atlas.client.put("#{url_builder.box_version_url}/release")
 
-      update_with_response(response.body)
+      update_with_response(response)
     end
 
     # Revoke the version.
@@ -108,16 +108,14 @@ module Atlas
     def revoke
       response = Atlas.client.put("#{url_builder.box_version_url}/revoke")
 
-      update_with_response(response.body)
+      update_with_response(response)
     end
 
     # Delete the version.
     #
     # @return [Hash] Atlas response object.
     def delete
-      response = Atlas.client.delete(url_builder.box_version_url)
-
-      JSON.parse(response.body)
+      Atlas.client.delete(url_builder.box_version_url)
     end
   end
 end

data/lib/atlas/client.rb

@@ -1,6 +1,8 @@
 module Atlas
   # Client for interacting with the Atlas API.
   class Client
+    include Atlas::Errors
+
     DEFAULT_HEADERS = { 'User-Agent' => "Atlas-Ruby/#{Atlas::VERSION}",
                         'Content-Type' => 'application/json' }
 
@@ -19,7 +21,7 @@ module Atlas
 
     private
 
-    def request(method, path, opts = {})
+    def request(method, path, opts = {}) # rubocop:disable AbcSize, MethodLength
       body, query, headers = parse_opts(opts)
 
       # set the default headers
@@ -29,9 +31,21 @@ module Atlas
       query.merge!(access_token: @access_token)
 
       connection = Excon.new(@url)
-      connection.request(expects: [200, 201], method: method,
-                         path: "/api/v1#{path}", body: body, query: query,
-                         headers: headers)
+      response = connection.request(expects: [200, 201], method: method,
+                                    path: "/api/v1#{path}", body: body,
+                                    query: query, headers: headers)
+
+      JSON.parse(response.body)
+    rescue Excon::Errors::BadRequest => e
+      raise ClientError, e.response.body
+    rescue Excon::Errors::Unauthorized => e
+      raise UnauthorizedError, e.response.body
+    rescue Excon::Errors::NotFound => e
+      raise NotFoundError, e.response.body
+    rescue Excon::Errors::InternalServerError => e
+      raise ServerError, e.response.body
+    rescue Excon::Errors::Timeout => e
+      raise TimeoutError, e.message
     end
 
     def parse_opts(opts)

data/lib/atlas/errors.rb

@@ -0,0 +1,25 @@
+module Atlas
+  # A collection of errors which can be raised by this gem.
+  module Errors
+    # Base error for all other gem errors.
+    class AtlasError < StandardError; end
+
+    # Raised when incorrect arguments are provided to a method.
+    class ArgumentError < AtlasError; end
+
+    # Raised when a request returns a 400 Bad Request.
+    class ClientError < AtlasError; end
+
+    # Raised when a request returns a 401 Unauthorized.
+    class UnauthorizedError < AtlasError; end
+
+    # Raised when a request returns a 404 Not Found.
+    class NotFoundError < AtlasError; end
+
+    # Raised when a request returns a 500 Server Error.
+    class ServerError < AtlasError; end
+
+    # Raised when a request times out.
+    class TimeoutError < AtlasError; end
+  end
+end

data/lib/atlas/resource.rb

@@ -10,13 +10,11 @@ module Atlas
       hash.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
     end
 
-    def update_with_response(o, except_keys = [])
-      hash = JSON.parse(o)
-
+    def update_with_response(response, except_keys = [])
       # remove keys that shouldn't be included
-      except_keys.each { |k| hash.delete(k) }
+      except_keys.each { |k| response.delete(k) }
 
-      hash.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      response.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
     end
 
     def to_hash

data/lib/atlas/user.rb

@@ -7,7 +7,7 @@ module Atlas
       url_builder = UrlBuilder.new(tag)
       response = Atlas.client.get(url_builder.user_url)
 
-      new(tag, JSON.parse(response.body))
+      new(tag, response)
     end
 
     def initialize(tag, hash = {})

data/lib/atlas/version.rb

@@ -1,4 +1,4 @@
 # Version information.
 module Atlas
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nick Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -132,6 +161,7 @@ files:
 - lib/atlas/box_version.rb
 - lib/atlas/client.rb
 - lib/atlas/configuration.rb
+- lib/atlas/errors.rb
 - lib/atlas/resource.rb
 - lib/atlas/url_builder.rb
 - lib/atlas/user.rb