atlas 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d7458c18f82f6db9fb3fd42f6c1191d010d1ac1
-  data.tar.gz: 1231af2fa78aedc507c897f09386c8b53beb376b
+  metadata.gz: 2327ab72bc81334bee756f79d747dbcbb7aaf69e
+  data.tar.gz: 82d266882fc5c21eb533f13b89731f630c36aa08
 SHA512:
-  metadata.gz: b188e800d63252dd99682ea50802fc59ab9608d6d036c17ab1877fa7ce3992abdd1823cf27b014980f57ce318aa3845d8da605a2fe1cc612a5aaedb73e32b173
-  data.tar.gz: 1271220ab59f2dfd908793e9a552b2ffd777be6f1ccc7271c8170831998e8e1e46675cea469217532fad9aa47ec0de783d23da6857714bb9278ee8f4e04b88e3
+  metadata.gz: a270dac6c5bcbbe5e5f0c5b62706b9ff40c870761ecffe17951bc9983878d153fa4db5631ef509fa36337453843e0b912bec00d661381392bd1ca7bd077abdd4
+  data.tar.gz: 83000712484128862ea561ed0fc7ff7fa80aba86390bc08c2dd42e565c646e3bbd2baf6cd7662e2cae9b9edd788a10d694269779bc243cc6c48c19342b2e883c

data/.travis.yml

@@ -1,6 +1,4 @@
+---
 language: ruby
 rvm:
   - 2.4.1
-addons:
-    code_climate:
-        repo_token: 17baf936cec8165bd651d58919ddcaa30f2a9d35f23290db4df618ac10a99743

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## 2.0.0 (07/04/2018)
+
+_**WARNING**: This will be the last major release of this gem. I recommend
+using [hashicorp/vagrant_cloud](https://github.com/hashicorp/vagrant_cloud) as
+it's maintained by HashiCorp._
+
+* Use headers, not query arguments for the token ([#23][]).
+* Deprecate the `access_token` configuration option ([#23][]).
+* Refresh cassettes ([#16][], [#17][], [#18][], [#19][], [#20][], [#21][],
+  [#22][]).
+* Implement validations for required attributes ([#14][]).
+* Improve `date_accessor` specs ([#13][]).
+* Rename keys in-place to avoid assigning nil ([#12][]).
+
+[#12]: https://github.com/nickcharlton/atlas-ruby/pull/12
+[#13]: https://github.com/nickcharlton/atlas-ruby/pull/13
+[#14]: https://github.com/nickcharlton/atlas-ruby/pull/14
+[#16]: https://github.com/nickcharlton/atlas-ruby/pull/16
+[#17]: https://github.com/nickcharlton/atlas-ruby/pull/17
+[#18]: https://github.com/nickcharlton/atlas-ruby/pull/18
+[#19]: https://github.com/nickcharlton/atlas-ruby/pull/19
+[#20]: https://github.com/nickcharlton/atlas-ruby/pull/20
+[#21]: https://github.com/nickcharlton/atlas-ruby/pull/21
+[#22]: https://github.com/nickcharlton/atlas-ruby/pull/22
+[#23]: https://github.com/nickcharlton/atlas-ruby/pull/23
+
 ## 1.6.0 (31/07/2016)
 
 * Switch to use the new Atlas API URL ([#11][])

data/README.md

@@ -1,8 +1,13 @@
 # atlas
 
 [![Build Status](https://travis-ci.org/nickcharlton/atlas-ruby.svg?branch=master)](https://travis-ci.org/nickcharlton/atlas-ruby)
-[![Code Climate](https://codeclimate.com/github/nickcharlton/atlas-ruby/badges/gpa.svg)](https://codeclimate.com/github/nickcharlton/atlas-ruby)
-[![Test Coverage](https://codeclimate.com/github/nickcharlton/atlas-ruby/badges/coverage.svg)](https://codeclimate.com/github/nickcharlton/atlas-ruby)
+
+_**WARNING**: 2.0.0 is the last major release of this gem. [Atlas became
+Vagrant Cloud on 2017-06-30][announcement], because of this, the name makes
+less sense than it did. Additionally, HashiCorp have their own gem:
+[hashicorp/vagrant_cloud](https://github.com/hashicorp/vagrant_cloud)._
+
+[announcement]: https://www.hashicorp.com/blog/vagrant-cloud-migration-announcement
 
 Atlas is a Ruby client for [Hashicorp][]'s [Atlas][].
 
@@ -29,7 +34,7 @@ Or install it yourself as:
 ```ruby
 # first, login with the token from Atlas
 Atlas.configure do |config|
-  config.access_token = 'token'
+  config.token = "test-token"
 end
 
 # then you can load in users (creating, updating, etc isn't supported by Atlas)

data/lib/atlas.rb

@@ -1,11 +1,13 @@
 require 'excon'
 require 'json'
+require "core_ext/hash_replace_key"
 
 require 'atlas/version'
 require 'atlas/configuration'
 require 'atlas/url_builder'
 require 'atlas/errors'
 require 'atlas/client'
+require "atlas/mixins/validations"
 require 'atlas/resource'
 require 'atlas/box_provider'
 require 'atlas/box_version'
@@ -17,6 +19,6 @@ module Atlas
   attr_accessor :client
 
   def self.client
-    @client ||= Client.new(access_token: configuration.access_token)
+    @client ||= Client.new(token: configuration.token)
   end
 end

data/lib/atlas/box.rb

@@ -11,9 +11,11 @@ module Atlas
   # @attr_accessor [Array] versions versions associated with this box.
   class Box < Resource
     attr_accessor :name, :username, :short_description, :description,
-                  :is_private, :current_version, :versions
+                  :private, :current_version, :versions
     date_accessor :created_at, :updated_at
 
+    requires :username, :name, :short_description, :description
+
     # Find a box by it's tag.
     #
     # @param [String] tag the tag of the box.
@@ -61,8 +63,8 @@ module Atlas
     #
     # @return [Box] a new box object.
     def initialize(tag, hash = {})
-      hash['is_private'] = hash['private']
-      hash['description'] = hash['description_markdown']
+      hash.replace_key!("private", "is_private")
+      hash.replace_key!("description_markdown", "description")
 
       super(tag, hash)
     end
@@ -106,6 +108,8 @@ module Atlas
     #
     # @return [Hash] Atlas response object.
     def save
+      validate!
+
       body = { box: to_hash }
 
       # versions are saved seperately
@@ -115,7 +119,9 @@ module Atlas
       begin
         response = Atlas.client.put(url_builder.box_url, body: body)
       rescue Atlas::Errors::NotFoundError
-        response = Atlas.client.post('/boxes', body: body)
+        body[:box].replace_key!(:private, :is_private)
+
+        response = Atlas.client.post("/boxes", body: body)
       end
 
       # trigger the same on versions

data/lib/atlas/box_provider.rb

@@ -7,6 +7,8 @@ module Atlas
     attr_accessor :name, :original_url, :download_url, :url
     date_accessor :created_at, :updated_at
 
+    requires :name
+
     # Find a provider by it's tag.
     #
     # @param [String] tag the tag of the provider.

data/lib/atlas/box_version.rb

@@ -12,6 +12,8 @@ module Atlas
     attr_accessor :version, :description, :status, :providers
     date_accessor :created_at, :updated_at
 
+    requires :version
+
     # Find a version by it's tag.
     #
     # @param [String] tag the tag of the version.
@@ -46,9 +48,7 @@ module Atlas
     # @param attr [String] :version The version number.
     # @param attr [String] :description Description of the box.
     def initialize(tag, hash = {})
-      if hash.key? 'description_markdown'
-        hash['description'] = hash['description_markdown']
-      end
+      hash.replace_key!("description_markdown", "description")
 
       super(tag, hash)
     end

data/lib/atlas/client.rb

@@ -10,7 +10,7 @@ module Atlas
 
     def initialize(opts = {})
       @url = opts[:url] || 'https://app.vagrantup.com/'
-      @access_token = opts[:access_token]
+      @token = opts[:token]
     end
 
     %w(get put post delete).each do |m|
@@ -21,6 +21,8 @@ module Atlas
 
     private
 
+    attr_reader :token
+
     def request(method, path, opts = {}) # rubocop:disable AbcSize, MethodLength
       body, query, headers = parse_opts(opts)
 
@@ -28,7 +30,7 @@ module Atlas
       headers.merge!(DEFAULT_HEADERS)
 
       # set the access token
-      query.merge!(access_token: @access_token)
+      headers["Authorization"] = "Bearer #{token}"
 
       connection = Excon.new(@url)
       response = connection.request(expects: [200, 201], method: method,

data/lib/atlas/configuration.rb

@@ -2,21 +2,27 @@ module Atlas
   # Configuration handling for Atlas.
   class Configuration
     # Access token for Atlas
-    attr_accessor :access_token
+    attr_accessor :token
 
     # Create a new Configuration instance
     #
     # This also allows providing a hash of configuration values, which calls
     # the accessor methods to full in the values.
     def initialize(opts = {})
-      opts.each do |k, v|
-        send("#{k}=".to_sym, v)
+      opts.each do |key, value|
+        if key.eql?(:access_token)
+          key = "token"
+          warn "WARNING: Setting the `:access_token` option is " \
+               "deprecated, use `:token` instead"
+        end
+
+        send("#{key}=".to_sym, value)
       end
     end
 
     # Hash representation of the configuration object.
     def to_h
-      { access_token: @access_token }
+      { token: @token }
     end
 
     # String representation of the configuration.
@@ -24,6 +30,13 @@ module Atlas
       objects = to_h.collect { |k, v| "#{k}=#{v}" }.join(' ')
       "#<#{self.class.name}:#{object_id} #{objects}"
     end
+
+    def access_token=(access_token)
+      warn "WARNING: Setting the `:access_token` option is " \
+           "deprecated, use `:token` instead"
+
+      @token = access_token
+    end
   end
 
   class << self

data/lib/atlas/errors.rb

@@ -4,6 +4,9 @@ module Atlas
     # Base error for all other gem errors.
     class AtlasError < StandardError; end
 
+    # Raised when a resource cannot be validated.
+    class InvalidResourceError < AtlasError; end
+
     # Raised when incorrect arguments are provided to a method.
     class ArgumentError < AtlasError; end
 

data/lib/atlas/mixins/validations.rb

@@ -0,0 +1,33 @@
+module Atlas
+  module Validations
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.extend(ClassMethods)
+    end
+
+    module InstanceMethods
+      def validate!
+        missing = self.class.required_attributes[self.class.name].reject do |k|
+          to_hash.include?(k) && !to_hash[k].nil?
+        end
+
+        if missing.any?
+          raise Atlas::Errors::InvalidResourceError,
+            "Missing attributes: #{missing.join(', ')}"
+        end
+      end
+    end
+
+    module ClassMethods
+      @@required_attributes = {}
+
+      def requires(*args)
+        args.each { |attr| (@@required_attributes[name] ||= []) << attr }
+      end
+
+      def required_attributes
+        @@required_attributes
+      end
+    end
+  end
+end

data/lib/atlas/resource.rb

@@ -1,8 +1,11 @@
-require "date"
+require "time"
 
 module Atlas
-  # Base class for representing resources.
   class Resource
+    include Validations
+
+    INTERNAL_ATTRIBUTE_KEYS = %w(@tag @url_builder).freeze
+
     attr_accessor :tag, :url_builder
 
     def initialize(tag, hash = {})
@@ -19,12 +22,14 @@ module Atlas
       response.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
     end
 
-    def to_hash
-      attrs = instance_variables.collect do |v|
-        %w(@tag @url_builder).include?(v.to_s) ? next : v.to_s.sub(/^@/, '')
+    def attributes
+      instance_variables.map do |v|
+        INTERNAL_ATTRIBUTE_KEYS.include?(v.to_s) ? next : v.to_s.sub(/^@/, "")
       end.compact!
+    end
 
-      Hash[attrs.select { |v| respond_to? v }.map { |v| [v.to_sym, send(v)] }]
+    def to_hash
+      Hash[attributes.map { |v| [v.to_sym, send(v)] }]
     end
 
     def inspect
@@ -36,7 +41,7 @@ module Atlas
       def date_writer(*args)
         args.each do |attr|
           define_method("#{attr}=".to_sym) do |date|
-            date = date.is_a?(String) ? DateTime.parse(date) : date
+            date = date.is_a?(String) ? Time.parse(date) : date
             instance_variable_set("@#{attr}", date)
           end
         end

data/lib/atlas/version.rb

@@ -1,4 +1,4 @@
 # Version information.
 module Atlas
-  VERSION = "1.6.0".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/core_ext/hash_replace_key.rb

@@ -0,0 +1,17 @@
+module HashReplaceKey
+  def replace_key(original, replacement)
+    dup.replace_key!(original, replacement)
+  end
+
+  def replace_key!(original, replacement)
+    return self unless has_key?(original)
+
+    self[replacement] = delete(original)
+
+    self
+  end
+end
+
+class Hash
+  include HashReplaceKey
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2018-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -87,7 +87,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
@@ -107,10 +106,12 @@ files:
 - lib/atlas/client.rb
 - lib/atlas/configuration.rb
 - lib/atlas/errors.rb
+- lib/atlas/mixins/validations.rb
 - lib/atlas/resource.rb
 - lib/atlas/url_builder.rb
 - lib/atlas/user.rb
 - lib/atlas/version.rb
+- lib/core_ext/hash_replace_key.rb
 homepage: https://github.com/nickcharlton/atlas-ruby
 licenses:
 - MIT

data/.codeclimate.yml

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