aptible-api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfdcc30829f257c5b6d98ad8ede2ea34b7a5f328
-  data.tar.gz: 79ce495635673d2b54c9e60d142fb7b2d27f13fd
+  metadata.gz: 0013944c43af6ae364441bcf5802e68defadc874
+  data.tar.gz: 26b2de9b909d738085ab83b7b397e3e13fb625a5
 SHA512:
-  metadata.gz: d435190c8b3dff583848b19285a2e50ef7d06bb7a1c9f10e8cd276eaa00e444e851e34a8da4c7a39f32d4674a771efd89c8d5b1675bad2534abcf639b85a9b26
-  data.tar.gz: 36a56dadd99b38fa76a6558fd598fee051f798fa41b0e3fcd018b2a2d8ec1a8564ea73ca56642daa65ff86d7f4b6af37408651bdfa0d38e79ff5732fc7e2f49f
+  metadata.gz: 12d71e142af40537c0a9c20974fb995604ebf7ac51340f994ab9915908bac2da3f37f74967c637939ed285b131938c36a019126b4f2f184415da46923dd534d0
+  data.tar.gz: ff6a9b5150ab4dd95332e389c96934699c8ff25e6c5bd90040137f2b1fccb432154034a26248de21b1634e0c840d427fc218f86d43eb2ee5fdb0957db00af112

data/Gemfile

@@ -1,7 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'oauth2', github: 'fancyremarker/oauth2', branch: 'aptible'
-gem 'hyperresource', github: 'fancyremarker/hyperresource', branch: 'aptible'
-
 # Specify your gem's dependencies in aptible-api.gemspec
 gemspec

data/Procfile

@@ -0,0 +1 @@
+console: bundle exec pry -r aptible/api

data/README.md

@@ -11,12 +11,11 @@ Ruby client for [api.aptible.com](https://api.aptible.com/). Aptible's API serve
 Add the following lines to your application's Gemfile.
 
     gem 'aptible-api'
-    gem 'hyperresource', github: 'fancyremarker/hyperresource', branch: 'aptible'
-
-The forked version of the HyperResource gem is necessary until [gamache/hyperresource#19](https://github.com/gamache/hyperresource/pull/19) is merged.
 
 And then run `bundle install`.
 
+*Note:* A forked version of the HyperResource gem (`hyperresource-aptible`) is necessary until [gamache/hyperresource#22](https://github.com/gamache/hyperresource/pull/22) and [gamache/hyperresource#23](https://github.com/gamache/hyperresource/pull/23) are merged.
+
 ## Usage
 
 First, get a token:

data/aptible-api.gemspec

@@ -3,11 +3,10 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'English'
-require 'aptible/api/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'aptible-api'
-  spec.version       = Aptible::Api::VERSION
+  spec.version       = '0.2.0'
   spec.authors       = ['Frank Macreery']
   spec.email         = ['frank@macreery.com']
   spec.description   = %q{Ruby client for api.aptible.com}
@@ -20,13 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'gem_config'
-  spec.add_dependency 'hyperresource'
+  spec.add_dependency 'hyperresource-aptible'
   spec.add_dependency 'aptible-auth'
   spec.add_dependency 'fridge'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'
+  spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'foreman'
   spec.add_development_dependency 'pry'
 end

data/lib/aptible/api/account.rb

@@ -0,0 +1,16 @@
+module Aptible
+  class Api::Account < Api::Resource
+    has_many :apps
+    has_many :disks
+    has_many :services
+
+    def production?
+      type == 'production'
+    end
+
+    def operations
+      # TODO: Implement /accounts/:id/operations
+      []
+    end
+  end
+end

data/lib/aptible/api/adapter.rb

@@ -0,0 +1,21 @@
+module Aptible
+  class Api::Adapter < HyperResource::Adapter::HAL_JSON
+    class << self
+      # rubocop:disable MethodLength
+      def get_data_type_from_object(object)
+        return nil unless object
+
+        if (type = object['_type'])
+          if type.respond_to?(:camelize)
+            type.camelize
+          else
+            type[0].upcase + type[1..-1]
+          end
+        else
+          'Resource'
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/api/app.rb

@@ -0,0 +1,8 @@
+module Aptible
+  class Api::App < Api::Resource
+    has_many :configurations
+    has_many :images
+    has_many :operations
+    has_many :permissions
+  end
+end

data/lib/aptible/api/attachment.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Attachment < Api::Resource
+  end
+end

data/lib/aptible/api/configuration.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Configuration < Api::Resource
+  end
+end

data/lib/aptible/api/container.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Container < Api::Resource
+  end
+end

data/lib/aptible/api/disk.rb

@@ -0,0 +1,6 @@
+module Aptible
+  class Api::Disk < Api::Resource
+    has_many :operations
+    has_many :permissions
+  end
+end

data/lib/aptible/api/image.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Image < Api::Resource
+  end
+end

data/lib/aptible/api/operation.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Operation < Api::Resource
+  end
+end

data/lib/aptible/api/permission.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Permission < Api::Resource
+  end
+end

data/lib/aptible/api/proxy.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Proxy < Api::Resource
+  end
+end

data/lib/aptible/api/release.rb

@@ -0,0 +1,5 @@
+module Aptible
+  class Api::Release < Api::Resource
+    has_many :containers
+  end
+end

data/lib/aptible/api/resource.rb

@@ -0,0 +1,49 @@
+require 'active_support/inflector'
+
+module Aptible
+  class Api::Resource < Api
+    def self.collection_url
+      basename = name.split('::').last
+      config = Aptible::Api.configuration
+      config.root_url.chomp('/') + "/#{basename.downcase.pluralize}"
+    end
+
+    def self.find(id)
+      find_by_url("#{collection_url}/#{id}")
+    end
+
+    def self.find_by_url(url)
+      # REVIEW: Should exception be raised if return type mismatch?
+      new.find_by_url(url)
+    rescue
+      nil
+    end
+
+    # rubocop:disable PredicateName
+    def self.has_many(relation)
+      define_method relation do
+        get unless loaded
+        if (memoized = instance_variable_get("@#{relation}"))
+          memoized
+        elsif links[relation]
+          instance_variable_set("@#{relation}", links[relation].entries)
+        end
+      end
+    end
+    # rubocop:enable PredicateName
+  end
+end
+
+require 'aptible/api/account'
+require 'aptible/api/app'
+require 'aptible/api/attachment'
+require 'aptible/api/configuration'
+require 'aptible/api/container'
+require 'aptible/api/disk'
+require 'aptible/api/image'
+require 'aptible/api/operation'
+require 'aptible/api/permission'
+require 'aptible/api/proxy'
+require 'aptible/api/release'
+require 'aptible/api/service'
+require 'aptible/api/vhost'

data/lib/aptible/api/service.rb

@@ -0,0 +1,9 @@
+module Aptible
+  class Api::Service < Api::Resource
+    has_many :vhosts
+    has_many :operations
+    has_many :permissions
+    has_many :proxies
+    has_many :releases
+  end
+end

data/lib/aptible/api/vhost.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Api::Vhost < Api::Resource
+  end
+end

data/lib/aptible/api.rb

@@ -1,16 +1,69 @@
-require 'aptible/api/version'
-require 'aptible/api/client'
-
+require 'aptible/auth'
 require 'gem_config'
+require 'hyperresource'
+require 'fridge'
 
 module Aptible
-  module Api
+  class Api < HyperResource
     include GemConfig::Base
 
+    attr_accessor :token, :config
+
     with_configuration do
       has :root_url,
           classes: [String],
           default: ENV['APTIBLE_API_ROOT_URL'] || 'https://api.aptible.com'
     end
+
+    def self.get_data_type_from_response(response)
+      return nil unless response && response.body
+      adapter.get_data_type_from_object(adapter.deserialize(response.body))
+    end
+
+    def self.adapter
+      Aptible::Api::Adapter
+    end
+
+    def adapter
+      self.class.adapter
+    end
+
+    def initialize(options = {})
+      if options.is_a?(Hash)
+        self.token = options[:token]
+
+        options[:root] ||= config.root_url
+        options[:namespace] ||= 'Aptible::Api'
+        options[:headers] ||= { 'Content-Type' => 'application/json' }
+        options[:headers].merge!(
+          'Authorization' => "Bearer #{bearer_token}"
+        ) if options[:token]
+      end
+
+      super(options)
+    end
+
+    def find_by_url(url)
+      fail "URL must be rooted at #{root}" unless /^#{root}/.match url
+
+      resource = dup
+      resource.href = url.gsub(/^#{root}/, '')
+      resource.get
+    end
+
+    def bearer_token
+      case token
+      when Aptible::Auth::Token then token.access_token
+      when Fridge::AccessToken then token.to_s
+      when String then token
+      end
+    end
+
+    def config
+      @config ||= Aptible::Api.configuration
+    end
   end
 end
+
+require 'aptible/api/adapter'
+require 'aptible/api/resource'

data/spec/aptible/api/resource_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Aptible::Api::Resource do
+  describe '.collection_url' do
+    it 'should use the pluralized resource name' do
+      url = Aptible::Api::Disk.collection_url
+      expect(url).to eq 'https://api.aptible.com/disks'
+    end
+  end
+
+  describe '.find' do
+    it 'should call find_by_url' do
+      url = 'https://api.aptible.com/disks/42'
+      expect(Aptible::Api::Disk).to receive(:find_by_url).with url
+      Aptible::Api::Disk.find(42)
+    end
+  end
+end

data/spec/aptible/api_spec.rb

@@ -1,6 +1,33 @@
 require 'spec_helper'
 
 describe Aptible::Api do
+  describe '#initialize' do
+    it 'should be a HyperResource instance' do
+      expect(subject).to be_a HyperResource
+    end
+  end
+
+  describe '#bearer_token' do
+    it 'should accept an Aptible::Auth::Token' do
+      token = Aptible::Auth::Token.new
+      token.stub(:access_token) { 'abtible_auth_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.access_token
+    end
+
+    it 'should accept an Fridge::AccessToken' do
+      token = Fridge::AccessToken.new
+      token.stub(:to_s) { 'fridge_access_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.to_s
+    end
+
+    it 'should accept a String' do
+      subject.stub(:token) { 'token' }
+      expect(subject.bearer_token).to eq 'token'
+    end
+  end
+
   it 'should have a configurable root_url' do
     config = described_class.configuration
     expect(config).to be_a GemConfig::Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hyperresource
+  name: hyperresource-aptible
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -148,13 +176,27 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE.md
+- Procfile
 - README.md
 - Rakefile
 - aptible-api.gemspec
 - lib/aptible/api.rb
-- lib/aptible/api/client.rb
-- lib/aptible/api/version.rb
-- spec/aptible/api/client_spec.rb
+- lib/aptible/api/account.rb
+- lib/aptible/api/adapter.rb
+- lib/aptible/api/app.rb
+- lib/aptible/api/attachment.rb
+- lib/aptible/api/configuration.rb
+- lib/aptible/api/container.rb
+- lib/aptible/api/disk.rb
+- lib/aptible/api/image.rb
+- lib/aptible/api/operation.rb
+- lib/aptible/api/permission.rb
+- lib/aptible/api/proxy.rb
+- lib/aptible/api/release.rb
+- lib/aptible/api/resource.rb
+- lib/aptible/api/service.rb
+- lib/aptible/api/vhost.rb
+- spec/aptible/api/resource_spec.rb
 - spec/aptible/api_spec.rb
 - spec/shared/set_env.rb
 - spec/spec_helper.rb
@@ -183,7 +225,7 @@ signing_key:
 specification_version: 4
 summary: Ruby client for api.aptible.com
 test_files:
-- spec/aptible/api/client_spec.rb
+- spec/aptible/api/resource_spec.rb
 - spec/aptible/api_spec.rb
 - spec/shared/set_env.rb
 - spec/spec_helper.rb

data/lib/aptible/api/client.rb

@@ -1,39 +0,0 @@
-require 'hyperresource'
-require 'aptible/auth'
-require 'fridge'
-
-module Aptible
-  module Api
-    class Client < HyperResource
-      attr_accessor :token, :config
-
-      def initialize(options = {})
-        unless options.is_a?(Hash)
-          fail ArgumentError, 'Call Aptible::Api::Client.new with a Hash'
-        end
-        self.token = options[:token]
-
-        options[:root] ||= config.root_url
-        options[:headers] ||= { 'Content-Type' => 'application/json' }
-        options[:headers].merge!(
-          'Authorization' => "Bearer #{bearer_token}"
-        ) if options[:token]
-
-        super(options)
-      end
-
-      def bearer_token
-        # REVIEW: Should we really allow any token type here?
-        case token
-        when Aptible::Auth::Token then token.access_token
-        when Fridge::AccessToken then token.to_s
-        when String then token
-        end
-      end
-
-      def config
-        @config ||= Aptible::Api.configuration
-      end
-    end
-  end
-end

data/lib/aptible/api/version.rb

@@ -1,5 +0,0 @@
-module Aptible
-  module Api
-    VERSION = '0.1.2'
-  end
-end

data/spec/aptible/api/client_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-
-describe Aptible::Api::Client do
-  describe '#initialize' do
-    it 'should be a HyperResource instance' do
-      expect(subject).to be_a HyperResource
-    end
-  end
-
-  describe '#bearer_token' do
-    it 'should accept an Aptible::Auth::Token' do
-      token = Aptible::Auth::Token.new
-      token.stub(:access_token) { 'abtible_auth_token' }
-      subject.stub(:token) { token }
-      expect(subject.bearer_token).to eq token.access_token
-    end
-
-    it 'should accept an Fridge::AccessToken' do
-      token = Fridge::AccessToken.new
-      token.stub(:to_s) { 'fridge_access_token' }
-      subject.stub(:token) { token }
-      expect(subject.bearer_token).to eq token.to_s
-    end
-
-    it 'should accept a String' do
-      subject.stub(:token) { 'token' }
-      expect(subject.bearer_token).to eq 'token'
-    end
-  end
-end