barge 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61432518c68ce3048755a40556dc53afdc00b3f4
-  data.tar.gz: 83ad99d33eebc187912e45547edbdfe59b8952b5
+  metadata.gz: a580428f182b00e938e6b137ca19d27f875be4ad
+  data.tar.gz: 6fd36010dac884e132d4d137de028a140a5c2091
 SHA512:
-  metadata.gz: b9f72efc66ce4041203e6086d8b5159f726b1cc1c54593a2c7ed5d6399597903092d1e5de6f5e7777732b6d2430502a2a8d8d8dd723f0b2c15919c1efb569b23
-  data.tar.gz: 659a25b05ae7b778294e692300c8f02e81d08ab0f88f320919c7bc06bdd7c3cedf238ce4ff22efa95a49e56bafa46b8325db69c27193fbe2eaf76bc2212f1b8e
+  metadata.gz: 7a7cb726892362d9d833f2f07d715ffd80f3eb68297f1a2c96da717438c322fb63b1105e39175803c3186834c1b12e342436f755109007956d56e97d97aa382e
+  data.tar.gz: 06d0c6b59f05acad0f15c76c5981f2cb3479e085c689c389398ad17bc6b3edf1f2ce2b53863d5c413d371d05d93a2b9f669911fc2e8ea19f69c42d0544635272

data/README.md

@@ -55,9 +55,9 @@ can be accessed using dot notation:
 
 ``` ruby
 droplet = barge.droplet.show(droplet_id)
-droplet.name        # => "foo"
-droplet.image.id    # => 123
-droplet.size!.vcpus # => 1
+droplet.droplet.name        # => "foo"
+droplet.droplet.image.id    # => 123
+droplet.droplet.size!.vcpus # => 1
 ```
 
 Notice that `size!` and not `size` was used. This is because `size` already is
@@ -65,10 +65,17 @@ a method, and Hashie::Mash will not override it. You can also use square
 brackets:
 
 ``` ruby
-droplet[:size][:vcpus]   # => 1
-droplet['size']['vcpus'] # => 1
+droplet[:droplet][:size][:vcpus]    # => 1
+droplet['droplet']['size']['vcpus'] # => 1
 ```
 
+See the [API documentation on responses][api-responses] if you are wondering
+why attributes are contained within a `droplet` key. This might change when
+pagination is fully implemented so you can say for instance `droplet.name`
+instead.
+
+[api-responses]: https://developers.digitalocean.com/#responses
+
 ### success?
 
 You can use `success?` to check if a successful HTTP status code was returned:
@@ -77,6 +84,56 @@ You can use `success?` to check if a successful HTTP status code was returned:
 barge.droplet.create(options).success? # => true
 ```
 
+### response
+
+Barge uses [Faraday][faraday]. You can use `response` to get to the response
+object:
+
+``` ruby
+barge.droplet.show(droplet_id).response # => Faraday::Response
+```
+
+[faraday]: https://github.com/lostisland/faraday
+
+Pagination
+----------
+
+For [paginated resources][api-links], a maximum of 200 objects are returned by
+default (the maximum allowed by the API).
+
+### Limit objects per page and/or get a specific page
+
+``` ruby
+barge.image.all(per_page: 10, page: 2)
+```
+
+[api-links]: https://developers.digitalocean.com/#links
+
+### Check if a response is paginated
+
+``` ruby
+barge.action.all.paginated? # => true
+barge.region.all.paginated? # => false
+```
+
+### Get the previous page number
+
+``` ruby
+barge.image.all(per_page: 5, page: 2).prev_page # => 1
+```
+
+### Get the next page number
+
+``` ruby
+barge.image.all(per_page: 5, page: 2).next_page # => 3
+```
+
+### Get the last page number
+
+``` ruby
+barge.image.all(per_page: 5, page: 2).last_page # => 8
+```
+
 Action
 ------
 

data/lib/barge.rb

@@ -2,6 +2,7 @@ require 'hashie'
 
 require 'barge/client'
 require 'barge/resource'
+require 'barge/response'
 require 'barge/version'
 
 module Barge

data/lib/barge/resource/action.rb

@@ -3,8 +3,8 @@ module Barge
     class Action
       include Resource::Base
 
-      def all
-        get('actions')
+      def all(options = {})
+        get('actions', options)
       end
 
       def show(action_id)

data/lib/barge/resource/base.rb

@@ -3,7 +3,7 @@ module Barge
     module Base
       attr_reader :faraday
 
-      PER_PAGE = 999
+      PER_PAGE = 200
 
       def initialize(faraday)
         @faraday = faraday
@@ -17,13 +17,9 @@ module Barge
         end
       end
 
-      def request(verb, *args)
-        options = { per_page: PER_PAGE } if verb == :get
-        response = faraday.public_send(verb, *args, options)
-        response.body.tap do |r|
-          r.define_singleton_method(:response) { response }
-          r.define_singleton_method(:success?) { response.success? }
-        end
+      def request(verb, path, options = {})
+        options = { per_page: PER_PAGE }.merge(options) if verb == :get
+        Response.new faraday.public_send(verb, path, options)
       end
     end
   end

data/lib/barge/resource/domain.rb

@@ -7,8 +7,8 @@ module Barge
         post('domains', options.to_json)
       end
 
-      def all
-        get('domains')
+      def all(options = {})
+        get('domains', options)
       end
 
       def show(domain_name)
@@ -23,8 +23,8 @@ module Barge
         post("domains/#{domain_name}/records", options.to_json)
       end
 
-      def records(domain_name)
-        get("domains/#{domain_name}/records")
+      def records(domain_name, options = {})
+        get("domains/#{domain_name}/records", options)
       end
 
       def show_record(domain_name, record_id)

data/lib/barge/resource/droplet.rb

@@ -7,8 +7,8 @@ module Barge
         post('droplets', options.to_json)
       end
 
-      def all
-        get('droplets')
+      def all(options = {})
+        get('droplets', options)
       end
 
       def show(droplet_id)

data/lib/barge/resource/image.rb

@@ -3,8 +3,8 @@ module Barge
     class Image
       include Resource::Base
 
-      def all
-        get('images')
+      def all(options = {})
+        get('images', options)
       end
 
       def show(image_id)

data/lib/barge/response.rb

@@ -0,0 +1,38 @@
+require 'forwardable'
+
+module Barge
+  class Response < Hashie::Mash
+    extend Forwardable
+
+    attr_reader :response
+    def_delegator :response, :success?, :success?
+
+    def initialize(faraday_response)
+      @response = faraday_response
+      super(faraday_response.body)
+    end
+
+    def paginated?
+      !(links && links.pages).nil?
+    end
+
+    def prev_page
+      extract_page(:prev)
+    end
+
+    def next_page
+      extract_page(:next)
+    end
+
+    def last_page
+      extract_page(:last)
+    end
+
+    private
+
+    def extract_page(key)
+      return unless paginated? && links.pages.key?(key)
+      Integer links.pages[key][/page=(\d+)/, 1]
+    end
+  end
+end

data/lib/barge/version.rb

@@ -1,7 +1,7 @@
 module Barge
   class Version
     MAJOR = 0
-    MINOR = 7
+    MINOR = 8
     PATCH = 0
 
     def self.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barge
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - "Ørjan Blom"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 description: Ruby library for version 2 of DigitalOcean's API
 email:
 - blom@blom.tv
@@ -73,6 +73,7 @@ files:
 - lib/barge/resource/key.rb
 - lib/barge/resource/region.rb
 - lib/barge/resource/size.rb
+- lib/barge/response.rb
 - lib/barge/version.rb
 homepage: https://github.com/boats/barge
 licenses: