fog-brightbox 0.1.0.dev1 → 0.1.0.dev2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4e4e8118a6b3a1f4ff00c8e2495689f3e7d92af
-  data.tar.gz: 836134a83b457a94ec52befd3e918f0de6a83661
+  metadata.gz: 4400838c756e050e5c2b3c2bd6d401fc26d914ef
+  data.tar.gz: f0da830e257111042e5cbafc6863c73196cfe49a
 SHA512:
-  metadata.gz: 2f9fe1a948fd47c16613664d04c3514f4760468d8128ab62bd82083e8e164a8e0175bf19e8d887dba58ae9123de18fbb3882df01db2ff69ace214716e68fd6da
-  data.tar.gz: 964d6ac09c9c329d2debd970e7d793c4448b807679daa5c6dcc6057ecc484fbe6e048a30d0f416284b34921b19a8bfba8da37769eaaf1c206aa7a9ce06ff0984
+  metadata.gz: b02335b2e9e290884a349f52f05d4fded3a63785846f0b744f23c4739ac539e779c24663f228eb6083a85bc95a0d33b8577ec9863ca50933c7afdb300ac1b8d5
+  data.tar.gz: 94c74114a0d84009ad5f6cb8fa361701fd7dbc36d80a5442f28e4cffab5e79c6a462d35c7335ebe3cbe82fbfdc5cc7c6862ce09ec879cdea0db0d26d2f526d0d

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+matrix:
+  include:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.1.8.7

data/CHANGELOG.md

@@ -1,9 +1,15 @@
-### 0.1.0.dev1 / PRELEASE
+### 0.1.0.dev2 / 2014-04-22
 
 This PRERELEASE version may contain functionality that is removed before the 
 next release so all APIs should be considered unstable and you should lock
 to the exact version if used!
 
+Bug fixes:
+
+* Reference fog-core-v1.22 rather than "master" branch now it is released.
+
+### 0.1.0.dev1 / 2014-04-10
+
 Enhancements:
 
 * Add support for events feed

data/fog-brightbox.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "fog-core"
+  spec.add_dependency "fog-core", "~> 1.22"
   spec.add_dependency "fog-json"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/gemfiles/Gemfile.1.8.7

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "fog-core", :github => "fog/fog-core"
+gem "mime-types", "~> 1.22"
+
+gemspec :path => ".."

data/lib/fog/brightbox/compute.rb

@@ -1,4 +1,5 @@
 require 'fog/brightbox/core'
+require 'fog/brightbox/compute/config'
 require 'fog/brightbox/compute/shared'
 require 'fog/brightbox/compute/image_selector'
 

data/lib/fog/brightbox/compute/config.rb

@@ -0,0 +1,23 @@
+require "delegate"
+
+module Fog
+  module Brightbox
+    module Compute
+      class Config < SimpleDelegator
+        def initialize(config)
+          super
+          @config = config
+          raise ArgumentError unless required_args_available?
+        end
+
+        private
+
+        def required_args_available?
+          return false unless @config.client_id
+          return false unless @config.client_secret
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/compute/shared.rb

@@ -17,49 +17,36 @@ module Fog
         # @note If you create service using just a refresh token when it
         #   expires the service will no longer be able to authenticate.
         #
-        # @param [Hash] options
-        # @option options [String] :brightbox_api_url
-        #   Override the default (or configured) API endpoint
-        # @option options [String] :brightbox_auth_url
-        #   Override the default (or configured) API authentication endpoint
-        # @option options [String] :brightbox_client_id
-        #   Client identifier to authenticate with (overrides configured)
-        # @option options [String] :brightbox_secret
-        #   Client secret to authenticate with (overrides configured)
-        # @option options [String] :brightbox_username
-        #   Email or user identifier for user based authentication
-        # @option options [String] :brightbox_password
-        #   Password for user based authentication
-        # @option options [String] :brightbox_account
-        #   Account identifier to scope this connection to
-        # @option options [String] :connection_options
-        #   Settings to pass to underlying {Fog::Core::Connection}
-        # @option options [Boolean] :persistent
-        #   Sets a persistent HTTP {Fog::Core::Connection}
-        # @option options [String] :brightbox_access_token
-        #   Sets the OAuth access token to use rather than requesting a new token
-        # @option options [String] :brightbox_refresh_token
-        #   Sets the refresh token to use when requesting a newer access token
-        # @option options [String] (true) :brightbox_token_management
-        # Overide the existing behaviour to request access tokens if expired
-        #
-        def initialize(options)
+        # @see Fog::Brightbox::Config#initialize Config object for possible configuration options
+        #
+        # @param [Brightbox::Config, Hash] config
+        #   Any configuration to be used for this service. This ideally should be in the newer form
+        #   of a {Brightbox::Config} object but may be a Hash.
+        #
+        def initialize(config)
+          if config.respond_to?(:config_service?) && config.config_service?
+            @config = config
+          else
+            @config = Fog::Brightbox::Config.new(config)
+          end
+          @config = Fog::Brightbox::Compute::Config.new(@config)
+
           # Currently authentication and api endpoints are the same but may change
-          @auth_url            = options[:brightbox_auth_url]  || API_URL
+          @auth_url            = @config.auth_url.to_s
           @auth_connection     = Fog::Core::Connection.new(@auth_url)
 
-          @api_url             = options[:brightbox_api_url]   || API_URL
-          @connection_options  = options[:connection_options]  || {}
-          @persistent          = options[:persistent]          || false
+          @api_url             = @config.compute_url.to_s
+          @connection_options  = @config.connection_options
+          @persistent          = @config.connection_persistent?
           @connection          = Fog::Core::Connection.new(@api_url, @persistent, @connection_options)
 
           # Authentication options
-          client_id            = options[:brightbox_client_id]
-          client_secret        = options[:brightbox_secret]
+          client_id            = @config.client_id
+          client_secret        = @config.client_secret
 
-          username             = options[:brightbox_username]
-          password             = options[:brightbox_password]
-          @configured_account  = options[:brightbox_account]
+          username             = @config.username
+          password             = @config.password
+          @configured_account  = @config.account
           # Request account can be changed at anytime and changes behaviour of future requests
           @scoped_account      = @configured_account
 
@@ -67,9 +54,9 @@ module Fog
           @credentials         = CredentialSet.new(client_id, client_secret, credential_options)
 
           # If existing tokens have been cached, allow continued use of them in the service
-          @credentials.update_tokens(options[:brightbox_access_token], options[:brightbox_refresh_token])
+          @credentials.update_tokens(@config.cached_access_token, @config.cached_refresh_token)
 
-          @token_management    = options.fetch(:brightbox_token_management, true)
+          @token_management    = @config.managed_tokens?
         end
 
         # Sets the scoped account for future requests
@@ -172,7 +159,7 @@ module Fog
         #
         def default_image
           return @default_image_id unless @default_image_id.nil?
-          @default_image_id = Fog.credentials[:brightbox_default_image] || select_default_image
+          @default_image_id = @config.default_image_id || select_default_image
         end
 
         private

data/lib/fog/brightbox/config.rb

@@ -0,0 +1,125 @@
+module Fog
+  module Brightbox
+    # The {Fog::Brightbox::Config} class is designed to encapsulate a group of settings for reuse
+    # between Brightbox services. The same config can be used for any service.
+    #
+    # The config also holds the latest set of access tokens which when shared means when one service
+    # is told a token has expired then another will not retry it.
+    #
+    class Config
+      # Creates a new set of configuration settings based on the options provided.
+      #
+      # @param [Hash] options The configuration settings
+      # @option options [String] :brightbox_access_token
+      #   Set to use a cached OAuth access token to avoid having to request new access rights.
+      # @option options [String] :brightbox_account
+      #   Set to specify the account to scope requests to if relevant. API clients are limited to
+      #   their owning accounts but users can access any account they collaborate on.
+      # @option options [String] :brightbox_api_url (https://api.gb1.brightbox.com)
+      #   Set an alternative API endpoint to send requests to.
+      # @option options [String] :brightbox_auth_url (https://api.gb1.brightbox.com)
+      #   Set an alternative OAuth authentication endpoint to send requests to.
+      # @option options [String] :brightbox_client_id
+      #   Set to specify the client identifier to use for requests. Either +cli-12345+ or
+      #   +app-12345+ are suitable settings.
+      # @option options [String] :brightbox_default_image
+      #   Set to specify a preferred image to use by default in the Compute service.
+      # @option options [String] :brightbox_password
+      #   Set to specify your user's password to authenticate yourself. This is independent of the
+      #   client used to access the API.
+      # @option options [String] :brightbox_refresh_token
+      #   Set to use a cached OAuth refresh token to avoid having to request new access rights.
+      # @option options [String] :brightbox_secret
+      #   Set to specify the client secret to use for requests.
+      # @option options [String] :brightbox_token_management (true)
+      #   Set to specify if the service should handle expired tokens or raise an error instead.
+      # @option options [String] :brightbox_username
+      #   Set to specify your user account. Either user identifier (+usr-12345+) or email address
+      #   may be used.
+      # @option options [String] :connection_options ({})
+      #   Set to pass options through to the HTTP connection.
+      # @option options [Boolean] :persistent (false)
+      #   Set to specify if the HTTP connection be persistent
+      #
+      # @example Use Fog.credentials
+      #   # Assuming credentials are setup to return Brightbox settings and not other providers!
+      #   @config = Fog::Brightbox::Config.new(Fog.credentials)
+      #
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Can this be used to configure services? Yes, yes it can.
+      #
+      # @return [true]
+      def config_service?
+        true
+      end
+
+      def to_hash
+        @options
+      end
+
+      # @return [URI::HTTPS] A URI object for the authentication endpoint
+      def auth_url
+        URI.parse(@options.fetch(:brightbox_auth_url, "https://api.gb1.brightbox.com"))
+      end
+
+      # @return [URI::HTTPS] A URI object for the main API/compute service endpoint
+      def compute_url
+        URI.parse(@options.fetch(:brightbox_api_url, "https://api.gb1.brightbox.com"))
+      end
+      alias_method :api_url, :compute_url
+
+      # @return [String] The configured  identifier of the API client or user application.
+      def client_id
+        @options[:brightbox_client_id]
+      end
+
+      # @return [String] The configured secret to use to identify the client.
+      def client_secret
+        @options[:brightbox_secret]
+      end
+
+      # @return [String] The configured email or user identified to use when accessing the API.
+      def username
+        @options[:brightbox_username]
+      end
+
+      # @return [String] The configured password to use to identify the user.
+      def password
+        @options[:brightbox_password]
+      end
+
+      # @return [String] The configured account identifier to scope API requests by.
+      def account
+        @options[:brightbox_account]
+      end
+
+      def connection_options
+        # These are pretty much passed through to the requests as is.
+        @options.fetch(:connection_options, {})
+      end
+
+      def connection_persistent?
+        @options.fetch(:persistent, false)
+      end
+
+      def cached_access_token
+        @options[:brightbox_access_token]
+      end
+
+      def cached_refresh_token
+        @options[:brightbox_refresh_token]
+      end
+
+      def managed_tokens?
+        @options.fetch(:brightbox_token_management, true)
+      end
+
+      def default_image_id
+        @options.fetch(:brightbox_default_image, nil)
+      end
+    end
+  end
+end

data/lib/fog/brightbox/core.rb

@@ -1,11 +1,11 @@
 require 'fog/core'
 require 'fog/json'
+require 'fog/brightbox/config'
 
 module Fog
   module Brightbox
     extend Fog::Provider
 
     service(:compute, 'Compute')
-
   end
 end

data/lib/fog/brightbox/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Brightbox
-    VERSION = "0.1.0.dev1"
+    VERSION = "0.1.0.dev2"
   end
 end

data/spec/fog/brightbox/compute/config_spec.rb

@@ -0,0 +1,40 @@
+require "minitest/autorun"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Compute::Config do
+  describe "when required arguments are included" do
+    it "nothing is raised" do
+      settings = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      Fog::Brightbox::Compute::Config.new(config)
+      pass
+    end
+  end
+
+  describe "when client_id is not in configuration" do
+    it "raises ArgumentError" do
+      settings = {
+        :brightbox_secret => "1234567890"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      assert_raises ArgumentError do
+        Fog::Brightbox::Compute::Config.new(config)
+      end
+    end
+  end
+
+  describe "when client_secret is not in configuration" do
+    it "raises ArgumentError" do
+      settings = {
+        :brightbox_client_id => "cli-12345"
+      }
+      config = Fog::Brightbox::Config.new(settings)
+      assert_raises ArgumentError do
+        Fog::Brightbox::Compute::Config.new(config)
+      end
+    end
+  end
+end

data/spec/fog/brightbox/config_spec.rb

@@ -0,0 +1,181 @@
+require "minitest/autorun"
+require "fog/brightbox"
+
+describe Fog::Brightbox::Config do
+  it "can be used to config services" do
+    @config = Fog::Brightbox::Config.new
+    assert @config.config_service?
+  end
+
+  describe "when created with Fog.credentials" do
+    it "does not error" do
+      @config = Fog::Brightbox::Config.new(Fog.credentials)
+      assert_instance_of Fog::Brightbox::Config, @config
+    end
+  end
+
+  describe "when created with a Hash" do
+    it "does not error" do
+      @options = {
+        :brightbox_client_id => "cli-12345"
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_instance_of Fog::Brightbox::Config, @config
+    end
+  end
+
+  describe "when auth url options was passed" do
+    it "returns the setting" do
+      @options = { :brightbox_auth_url => "https://api.gb1.brightbox.com" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_instance_of URI::HTTPS, @config.auth_url
+    end
+  end
+
+  describe "when auth url is not specified" do
+    it "returns the default" do
+      @config = Fog::Brightbox::Config.new({})
+      assert_instance_of URI::HTTPS, @config.auth_url
+      assert_equal "https://api.gb1.brightbox.com", @config.auth_url.to_s
+    end
+  end
+
+  describe "when compute url options was passed" do
+    it "returns the setting" do
+      @options = { :brightbox_api_url => "https://api.gb1.brightbox.com" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_instance_of URI::HTTPS, @config.compute_url
+      assert_equal @config.compute_url, @config.api_url
+    end
+  end
+
+  describe "when compute url is not specified" do
+    it "returns the default" do
+      @config = Fog::Brightbox::Config.new({})
+      assert_instance_of URI::HTTPS, @config.compute_url
+      assert_equal "https://api.gb1.brightbox.com", @config.compute_url.to_s
+      assert_equal @config.compute_url, @config.api_url
+    end
+  end
+
+  describe "when client id is passed" do
+    it "returns the settings" do
+      @options = { :brightbox_client_id => "cli-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "cli-12345", @config.client_id
+    end
+  end
+
+  describe "when client secret is passed" do
+    it "returns the settings" do
+      @options = { :brightbox_secret => "secret" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "secret", @config.client_secret
+    end
+  end
+
+  describe "when username is passed" do
+    it "returns the settings" do
+      @options = { :brightbox_username => "usr-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "usr-12345", @config.username
+    end
+  end
+
+  describe "when password is passed" do
+    it "returns the settings" do
+      @options = { :brightbox_password => "password" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "password", @config.password
+    end
+  end
+
+  describe "when account is passed" do
+    it "returns the settings" do
+      @options = { :brightbox_account => "acc-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "acc-12345", @config.account
+    end
+  end
+
+  describe "when connection options are passed" do
+    it "returns the settings" do
+      @connection_settings = {
+        :headers => {
+          "Content-Type" => "application/json"
+        }
+      }
+      @options = {
+        :connection_options => @connection_settings
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal @connection_settings, @config.connection_options
+    end
+  end
+
+  describe "when no connection options were passed" do
+    it "returns an empty hash" do
+      @config = Fog::Brightbox::Config.new
+      assert_equal({}, @config.connection_options)
+    end
+  end
+
+  describe "when persistent connection is requested" do
+    it "returns true for the setting" do
+      @options = { :persistent => true }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert @config.connection_persistent?
+    end
+  end
+
+  describe "when persistent connection is not specified" do
+    it "returns false by default" do
+      @config = Fog::Brightbox::Config.new
+      refute @config.connection_persistent?
+    end
+  end
+
+  describe "when cached OAuth tokens were passed" do
+    it "returns the settings" do
+      @access_token = "1234567890abcdefghijklmnopqrstuvwxyz"
+      @refresh_token = "1234567890abcdefghijklmnopqrstuvwxyz"
+      @options = {
+        :brightbox_access_token => @access_token,
+        :brightbox_refresh_token => @refresh_token
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal @access_token, @config.cached_access_token
+      assert_equal @refresh_token, @config.cached_refresh_token
+    end
+  end
+
+  describe "when token management is not specified" do
+    it "returns true by default" do
+      @config = Fog::Brightbox::Config.new
+      assert @config.managed_tokens?
+    end
+  end
+
+  describe "when token management setting is disabled" do
+    it "returns false" do
+      @options = { :brightbox_token_management => false }
+      @config = Fog::Brightbox::Config.new(@options)
+      refute @config.managed_tokens?
+    end
+  end
+
+  describe "when a default server image is configured" do
+    it "returns the configured setting" do
+      @options = { :brightbox_default_image => "img-12345" }
+      @config = Fog::Brightbox::Config.new(@options)
+      assert_equal "img-12345", @config.default_image_id
+    end
+  end
+
+  describe "when a default server is not set" do
+    it "returns nil" do
+      @config = Fog::Brightbox::Config.new
+      assert_nil @config.default_image_id
+    end
+  end
+end

data/spec/fog/compute/brightbox_spec.rb

@@ -46,4 +46,25 @@ describe Fog::Compute::Brightbox do
       end
     end
   end
+
+  describe "when created with a Config object" do
+    it "does not error" do
+      @options = {
+        :brightbox_client_id => "cli-12345",
+        :brightbox_secret => "1234567890"
+      }
+      @config = Fog::Brightbox::Config.new(@options)
+      @service = Fog::Compute::Brightbox.new(@config)
+      pass
+    end
+  end
+
+  describe "when created with Config missing required settings" do
+    it "raises ArgumentError"do
+      @config = Fog::Brightbox::Config.new({})
+      assert_raises ArgumentError do
+        @service = Fog::Compute::Brightbox.new(@config)
+      end
+    end
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fog-brightbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev1
+  version: 0.1.0.dev2
 platform: ruby
 authors:
 - Paul Thornthwaite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: fog-json
   requirement: !ruby/object:Gem::Requirement
@@ -88,16 +88,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - fog-brightbox.gemspec
+- gemfiles/Gemfile.1.8.7
 - lib/fog/brightbox.rb
 - lib/fog/brightbox/compute.rb
+- lib/fog/brightbox/compute/config.rb
 - lib/fog/brightbox/compute/image_selector.rb
 - lib/fog/brightbox/compute/shared.rb
+- lib/fog/brightbox/config.rb
 - lib/fog/brightbox/core.rb
 - lib/fog/brightbox/models/compute/account.rb
 - lib/fog/brightbox/models/compute/accounts.rb
@@ -241,6 +245,8 @@ files:
 - lib/fog/brightbox/requests/compute/update_server_group.rb
 - lib/fog/brightbox/requests/compute/update_user.rb
 - lib/fog/brightbox/version.rb
+- spec/fog/brightbox/compute/config_spec.rb
+- spec/fog/brightbox/config_spec.rb
 - spec/fog/compute/brightbox_spec.rb
 homepage: ''
 licenses:
@@ -268,4 +274,6 @@ specification_version: 4
 summary: This library can be used as a module for `fog` or as standalone provider
   to use the Brightbox Cloud in applications
 test_files:
+- spec/fog/brightbox/compute/config_spec.rb
+- spec/fog/brightbox/config_spec.rb
 - spec/fog/compute/brightbox_spec.rb