droplet_kit 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a7043fefd42f5297c3f91fa3033c30a47ff86fd
-  data.tar.gz: 2dfc49f1230133e864b1b9373a6caee0c7b9c5e3
+  metadata.gz: 6e28942bdd478cd811a6f8e8aa0ee9632b5d4f50
+  data.tar.gz: 96fca5ad6cb96e1e4c58f0d4bc513bcc770e05a7
 SHA512:
-  metadata.gz: da1218af357c9a2c1ef5cd2650d583cd2899b4895760747438054e8d353de5c1479a186427ef3711c2f541333d189a19d6c5fc7aff193cd0b08393018514f004
-  data.tar.gz: f37b970dd2c05bad03039fbaadd98736c70e4c889014f9e01a5ddcdf11d3b5150196ba7a6da908f028b104c7232b8089d4b2d3cf3e2b32f0500a8b9032300364
+  metadata.gz: 1efaaffe2af2dd9f717e09c61742a16fb6c8c3bf3602e67164550bd3c7842cf26b7b7d35165a8447c366ecc97528c22e65c86b399c7a9204a2284d9ebb6ed65f
+  data.tar.gz: 32839b6b91778d2414440ecb9de9b8aad17a1306525d55226fe462b15abcbfc3287233858eea2672568b1beccb8d8782dcc38ef4830a0a88e8a24a94c907ad6b

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'simplecov'
 # Specify your gem's dependencies in droplet_kit.gemspec
 gemspec

data/README.md

@@ -121,6 +121,12 @@ Actions supported:
 
     client = DropletKit::Client.new(access_token: 'TOKEN')
     client.domain_records #=> DropletKit::DomainRecordResource
+    domain_record = DropletKit::DomainRecord.new(
+        type: 'CNAME',
+        name: 'www',
+        data: '@'
+    )
+
 
 Actions supported:
 
@@ -144,6 +150,18 @@ Actions supported:
 * `client.images.update(image, id: 'id')`
 
 
+## Image Action Resource
+
+    client = DropletKit::Client.new(access_token: 'TOKEN')
+    client.image_actions #=> DropletKit::ImageActionResource
+
+Image Actions Supported:
+
+* `client.image_actions.all(image_id: 123)`
+* `client.image_actions.find(image_id: 123, id: 123455)`
+* `client.image_actions.transfer(image_id: 123, region: 'nyc3')`
+
+
 ## Region resource
 
     client = DropletKit::Client.new(access_token: 'TOKEN')

data/droplet_kit.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = DropletKit::VERSION
   spec.authors       = ["Robert Ross"]
   spec.email         = ["rross@digitalocean.com"]
-  spec.summary       = %q{Droplet Kit is the official Ruby library for Digital Ocean's API}
-  spec.description   = %q{Droplet Kit is the official Ruby library for Digital Ocean's API}
+  spec.summary       = %q{Droplet Kit is the official Ruby library for DigitalOcean's API}
+  spec.description   = %q{Droplet Kit is the official Ruby library for DigitalOcean's API}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -17,13 +17,14 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'virtus', '~> 1.0.3'
   spec.add_dependency "resource_kit", '~> 0.1.1'
   spec.add_dependency "kartograph", '~> 0.2.0'
   spec.add_dependency "activesupport", '~> 4.1.6'
+  spec.add_dependency "faraday", '~> 0.9.1'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/droplet_kit/paginated_resource.rb

@@ -40,7 +40,13 @@ module DropletKit
     end
 
     def last?
-      @current_page == (self.total.to_f / per_page.to_f).ceil
+      @current_page == total_pages || self.total.zero?
+    end
+
+    def total_pages
+      return nil if self.total.nil?
+      
+      (self.total.to_f / per_page.to_f).ceil
     end
 
     def ==(other)

data/lib/droplet_kit/resources/image_action_resource.rb

@@ -6,9 +6,17 @@ module DropletKit
         handler(200, 201) { |response| ImageActionMapping.extract_single(response.body, :read) }
       end
 
+      action :all, 'GET /v2/images/:image_id/actions' do
+        handler(200) { |response| ImageActionMapping.extract_collection(response.body, :read) }
+      end
+
       action :find, 'GET /v2/images/:image_id/actions/:id' do
         handler(200) { |response| ImageActionMapping.extract_single(response.body, :read) }
       end
     end
+
+    def all(*args)
+      PaginatedResource.new(action(:all), self, *args)
+    end
   end
 end

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/fixtures/droplets/all_empty.json

@@ -0,0 +1,7 @@
+{
+  "droplets": [
+  ],
+  "meta": {
+    "total": 0
+  }
+}

data/spec/fixtures/image_actions/all.json

@@ -0,0 +1,28 @@
+{
+    "actions": [
+        {
+            "id": 298374,
+            "status": "completed",
+            "type": "image_destroy",
+            "started_at": "2014-10-28T17:11:05Z",
+            "completed_at": "2014-10-28T17:11:06Z",
+            "resource_id": 45646587,
+            "resource_type": "image",
+            "region": null
+        },
+        {
+            "id": 234598,
+            "status": "completed",
+            "type": "transfer",
+            "started_at": "2014-10-28T17:09:11Z",
+            "completed_at": "2014-10-28T17:12:04Z",
+            "resource_id": 45646587,
+            "resource_type": "image",
+            "region": "nyc2"
+        }
+    ],
+    "links": {},
+    "meta": {
+        "total": 2
+    }
+}

data/spec/lib/droplet_kit/client_spec.rb

@@ -10,6 +10,17 @@ RSpec.describe DropletKit::Client do
     end
   end
 
+  describe "#method_missing" do
+
+    context "called with an existing method" do
+      it { expect{ client.actions}.to_not raise_error }
+    end
+
+    context "called with a missing method" do
+      it { expect{client.this_is_wrong}.to raise_error(NoMethodError) }
+    end
+  end
+
   describe '#connection' do
     it 'populates the authorization header correctly' do
       expect(client.connection.headers['Authorization']).to eq("Bearer #{client.access_token}")

data/spec/lib/droplet_kit/models/base_model_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe DropletKit::BaseModel do
+  subject(:resource) do
+    Class.new(DropletKit::BaseModel) do |base|
+      attribute :droplet_limit
+      def self.name
+        'SomeModel'
+      end
+    end
+  end
+
+  describe '#inspect' do
+    it 'returns the information about the current user' do
+      instance = resource.new(droplet_limit: 5)
+      expect(instance.inspect).to include("<SomeModel")
+      expect(instance.inspect).to include("@droplet_limit=>5")
+      expect(instance.inspect).to include("<SomeModel {:@droplet_limit=>5}>")
+    end
+  end
+end

data/spec/lib/droplet_kit/paginated_resource_spec.rb

@@ -8,21 +8,8 @@ RSpec.describe DropletKit::PaginatedResource do
   let(:request_count) { RequestCounter.new(0) }
 
   let(:connection) { Faraday.new {|b| b.adapter :test, stubs } }
-  let(:stubs) do
-    Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/droplets') do |env|
-        request_count.count += 1
-        uri = Addressable::URI.parse(env[:url].to_s)
-        page = (uri.query_values['page'] || 1).to_i
-        per_page = (uri.query_values['per_page'] || 20).to_i
-        range = (0...per_page).map do |num|
-          num + ((page - 1) * per_page)
-        end
-
-        [200, {}, { objects: range, meta: { total: 40 } }.to_json ]
-      end
-    end
-  end
+  let(:response_size) { 40 }
+  let(:stubs) { stub_pager_request(response_size) }
   let(:action) { ResourceKit::Action.new(:find, :get, '/droplets') }
 
   before do
@@ -38,6 +25,26 @@ RSpec.describe DropletKit::PaginatedResource do
     end
   end
 
+  describe "#total_pages" do
+    let(:instance) { DropletKit::PaginatedResource.new(action, resource) }
+    it "returns nil if no request made" do
+      expect(instance.total_pages).to be_nil
+    end
+
+    it "returns correct page count after request made" do
+      instance.take(20)
+      expect(instance.total_pages).to eq(2)
+    end
+
+    context "when results are empty" do
+      let(:stubs) { stub_pager_request(0) }
+      it "returns 0" do
+        instance.take(1)
+        expect(instance.total_pages).to eq(0)
+      end
+    end
+  end
+
   describe '#each' do
     subject(:paginated) { DropletKit::PaginatedResource.new(action, resource) }
 

data/spec/lib/droplet_kit/resources/droplet_resource_spec.rb

@@ -69,6 +69,12 @@ RSpec.describe DropletKit::DropletResource do
 
       check_droplet(droplets.first)
     end
+
+    it 'returns an empty array of droplets' do
+      stub_do_api('/v2/droplets', :get).to_return(body: api_fixture('droplets/all_empty'))
+      droplets = resource.all.map(&:id)
+      expect(droplets).to be_empty
+    end
   end
 
   describe '#find' do

data/spec/lib/droplet_kit/resources/image_action_resource_spec.rb

@@ -26,6 +26,32 @@ RSpec.describe DropletKit::ImageActionResource do
     end
   end
 
+  describe '#all' do
+    it 'returns all of the image actions via a paginated resources' do
+      request = stub_do_api('/v2/images/449676391/actions', :get).to_return(
+        body: api_fixture('image_actions/all'),
+        status: 200
+      )
+
+      actions = resource.all(image_id: 449676391).take(20)
+
+      expect(request).to have_been_made
+
+      expect(actions.size).to be(2)
+
+      action = actions.first
+
+      expect(action.id).to eq(298374)
+      expect(action.status).to eq("completed")
+      expect(action.type).to eq("image_destroy")
+      expect(action.started_at).to eq("2014-10-28T17:11:05Z")
+      expect(action.completed_at).to eq("2014-10-28T17:11:06Z")
+      expect(action.resource_id).to eq(45646587)
+      expect(action.resource_type).to eq("image")
+      expect(action.region).to eq(nil)
+    end
+  end
+
   describe '#find' do
     it 'returns a single action' do
       stub_do_api('/v2/images/449676391/actions/23').to_return(body: api_fixture('image_actions/find'))

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
+require 'simplecov'
+
+SimpleCov.start
+
 require 'droplet_kit'
 require 'webmock/rspec'
 
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter
+]
+
 Dir['./spec/support/**/*.rb'].each do |file|
   require file
 end

data/spec/support/null_hash_load.rb

@@ -1,8 +1,4 @@
 class NullHashLoad
-  def self.load(hash)
-    hash
-  end
-
   def self.dump(hash)
     hash
   end

data/spec/support/request_stub_helpers.rb

@@ -6,4 +6,23 @@ module RequestStubHelpers
   def api_fixture(fixture_name)
     Pathname.new('./spec/fixtures/').join("#{fixture_name}.json").read
   end
+
+  def stub_pager_request(total_results = 40) 
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/droplets') do |env|
+        request_count.count += 1
+        uri = Addressable::URI.parse(env[:url].to_s)
+        page = (uri.query_values['page'] || 1).to_i
+        per_page = (uri.query_values['per_page'] || 20).to_i
+
+        max_elems = [total_results, per_page].min
+
+        range = (0...max_elems).map do |num|
+          num + ((page - 1) * per_page)
+        end
+
+        [200, {}, { objects: range, meta: { total: total_results } }.to_json ]
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +164,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-description: Droplet Kit is the official Ruby library for Digital Ocean's API
+description: Droplet Kit is the official Ruby library for DigitalOcean's API
 email:
 - rross@digitalocean.com
 executables: []
@@ -227,12 +241,14 @@ files:
 - spec/fixtures/domains/create.json
 - spec/fixtures/domains/find.json
 - spec/fixtures/droplets/all.json
+- spec/fixtures/droplets/all_empty.json
 - spec/fixtures/droplets/create.json
 - spec/fixtures/droplets/find.json
 - spec/fixtures/droplets/list_actions.json
 - spec/fixtures/droplets/list_backups.json
 - spec/fixtures/droplets/list_kernels.json
 - spec/fixtures/droplets/list_snapshots.json
+- spec/fixtures/image_actions/all.json
 - spec/fixtures/image_actions/create.json
 - spec/fixtures/image_actions/find.json
 - spec/fixtures/images/all.json
@@ -244,6 +260,7 @@ files:
 - spec/fixtures/ssh_keys/find.json
 - spec/fixtures/ssh_keys/update.json
 - spec/lib/droplet_kit/client_spec.rb
+- spec/lib/droplet_kit/models/base_model_spec.rb
 - spec/lib/droplet_kit/models/droplet_spec.rb
 - spec/lib/droplet_kit/paginated_resource_spec.rb
 - spec/lib/droplet_kit/resources/account_resource_spec.rb
@@ -285,7 +302,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Droplet Kit is the official Ruby library for Digital Ocean's API
+summary: Droplet Kit is the official Ruby library for DigitalOcean's API
 test_files:
 - spec/fixtures/account/info.json
 - spec/fixtures/actions/all.json
@@ -298,12 +315,14 @@ test_files:
 - spec/fixtures/domains/create.json
 - spec/fixtures/domains/find.json
 - spec/fixtures/droplets/all.json
+- spec/fixtures/droplets/all_empty.json
 - spec/fixtures/droplets/create.json
 - spec/fixtures/droplets/find.json
 - spec/fixtures/droplets/list_actions.json
 - spec/fixtures/droplets/list_backups.json
 - spec/fixtures/droplets/list_kernels.json
 - spec/fixtures/droplets/list_snapshots.json
+- spec/fixtures/image_actions/all.json
 - spec/fixtures/image_actions/create.json
 - spec/fixtures/image_actions/find.json
 - spec/fixtures/images/all.json
@@ -315,6 +334,7 @@ test_files:
 - spec/fixtures/ssh_keys/find.json
 - spec/fixtures/ssh_keys/update.json
 - spec/lib/droplet_kit/client_spec.rb
+- spec/lib/droplet_kit/models/base_model_spec.rb
 - spec/lib/droplet_kit/models/droplet_spec.rb
 - spec/lib/droplet_kit/paginated_resource_spec.rb
 - spec/lib/droplet_kit/resources/account_resource_spec.rb