cubits 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d337170a2395378547f050001109b90f2387bb58
-  data.tar.gz: 8b505f0edeb55b9a5c1a518f8dad387a9e167f42
+  metadata.gz: f5511ab4b3447612a3c1b70d5c56b6990ad321cc
+  data.tar.gz: 014d343a1b5cb390dc820fd6cb81e0fc5fd574fd
 SHA512:
-  metadata.gz: b2c5625fe8ae836a0fb521e2b423eed6af3eca3c95d44988b8497bb2710201ea0a176ef81cabd2155c3ff04deda7f164d11fab2dc4d8f81b6a9b41de373dbc88
-  data.tar.gz: 9327d05bb549d9478ea3d03112fc98d4dfa9cde73c3f1dc83e9fab0e054e15bea76bc098f21cc9c3291330645ab5cb3b45b99884586418b164f900d96088d31b
+  metadata.gz: 0b6f04d5f24a2a85ad94bfe4631cde2084e1d904b9afb7647e17183f21df82e474da51239d9d6dd572b9f50a7b740573340e916c8b3d6a0e992c25c1bf75d2e3
+  data.tar.gz: a6493083f990beab6a4908bdda55a80ae3460774518547a777bc8cd2e32c74560f50696588fd43968d6c11f4d5d60cbbc9ead7a0f061fb652e8976ff6b3585a2

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.6.0
+
+* Added Cubits::ResourceCollection, which implements Ruby [Enumerable](http://ruby-doc.org/core-2.2.1/Enumerable.html)
+plus some helper methods
+* `Cubits::Channel#txs` now is a `Cubits::ResourceCollection` of `Cubits::Channel::Tx`
+
 # 0.5.0
 
 * Added Cubits::Channel::Tx collection implementation.

data/README.md

@@ -147,24 +147,85 @@ channel.reference # => "CHAN_192357"
 
 #### #txs
 
-Returns channel transactions as a collection of `Cubits::Channel::Tx` objects.
+Returns channel transactions as `Cubits::ResourceCollection` of `Cubits::Channel::Tx` objects.
 
-The collection exposes methods `.all` and `.find()`:
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.count # => 42
+```
+
+### Cubits::ResourceCollection
+
+The `Cubits::ResourceCollection` object represents a collection of resources of a particular type:
+
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs # => <Cubits::ResourceCollection of Cubits::Channel::Tx ...>
+```
+
+`Cubits::ResourceCollection` implements Ruby [Enumerable](http://ruby-doc.org/core-2.2.1/Enumerable.html) interface, and therefore exposes all the basic iterators (`#each`, `#select`, `#map`) as well as [many other methods](http://ruby-doc.org/core-2.2.1/Enumerable.html).
+
+In addition to that, some helper methods are implemented:
+
+#### #count
+
+Returns number of elements in the collection:
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.count # => 42
+```
+
+#### #all
+
+Returns all the elements of the collection as an `Array`:
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.all # => [{ "tx_ref_code"=>"YYWZN",
+                #       "state"=>"pending",
+                #       "channel_id"=>"d17ad6c96f83162a2764ecd4739d7ab2",
+                #       ...
+                #     },
+                #     ...
+                #    ]
+```
+
+#### #first
+
+Returns the first element of the collection:
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.first # => { "tx_ref_code"=>"YYWZN", "state" => "pending", ... }
+```
+
+#### #last
 
-Listing all channel transactions:
+Returns the last element of the collection:
 ```ruby
 channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.last # => { "tx_ref_code"=>"WWZKX", "state" => "completed", ... }
+```
+
+#### #find(*id*)
+
+Finds and returns an element in the collection with a given *id* (or *tx_ref_code* in case of Cubits::Channel::Tx), or `nil` if the element cannot be found.
 
-channel.txs.all # => [{"tx_ref_code"=>"YYWZN", ...}, ...]
+```ruby
+channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
+channel.txs.find("PGDAV") # => { "tx_ref_code"=>"PGDAV", "state" => "completed", ... }
 ```
 
-Retrieving a channel transaction with given *tx_ref_code*:
+#### #reload
+
+Reloads collection. Resets preloaded elements and element count.
+
 ```ruby
 channel = Cubits::Channel.find("d17ad6c96f83162a2764ecd4739d7ab2")
-tx = channel.txs.find("YYWZN")
-tx.class # => Cubits::Channel::Tx
+channel.txs.count # => 42
+
+# ... new transaction is created
 
-tx # => {"tx_ref_code"=>"YYWZN", "state"=>"pending", ... }
+channel.txs.count # => 42
+channel.txs.reload.count # => 43
 ```
 
 ### Cubits::Channel::Tx

data/lib/cubits/resource_collection.rb

@@ -1,5 +1,7 @@
 module Cubits
   class ResourceCollection
+    include Enumerable
+
     attr_reader :path, :resource
 
     def initialize(params = {})
@@ -20,6 +22,12 @@ module Cubits
       (@exposed_methods || []).include?(method_name)
     end
 
+    # Returns number of elements in the collection
+    #
+    def count
+      pagination.total_count
+    end
+    alias_method :size, :count
 
     # Loads collection of resources
     #
@@ -27,9 +35,25 @@ module Cubits
     #
     def all
       fail NoMethodError, "Resource #{name} does not expose .all" unless exposed_method?(:all)
-      Cubits.connection.get(path_to, per_page: 1000)[collection_name].map { |r| resource.new r }
+      list = []
+      page_count.times do |i|
+        list += page(i + 1)
+      end
+      list
     rescue NotFound
-      nil
+      []
+    end
+
+    # Returns first element of the collection
+    #
+    def first
+      first_page.first
+    end
+
+    # Returns last element of the collection
+    #
+    def last
+      last_page.last
     end
 
     # Loads resource
@@ -45,6 +69,27 @@ module Cubits
       nil
     end
 
+    # Reloads collection
+    #
+    # @return [self]
+    #
+    def reload
+      @pagination = nil
+      @pages = nil
+      self
+    end
+
+    # Iterates through the collection, yielding the giving block for each resource.
+    #
+    def each(&_block)
+      return to_enum unless block_given?
+      page_count.times do |i|
+        page(i + 1).each do |r|
+          yield r
+        end
+      end
+    end
+
     # Returns API path to resource
     #
     def path_to(resource_or_id = nil)
@@ -63,7 +108,61 @@ module Cubits
     end
 
     def to_s
-      "<#{self.class.name}:<#{resource.name}>:#{path}>"
+      "<#{self.class.name} of #{resource.name}, #{path}>"
+    end
+
+    private
+
+    # Returns current pagination object.
+    # If pagination was not requested yet, does a one page request
+    #
+    def pagination
+      return @pagination if @pagination
+      first_page
+      @pagination
+    end
+
+    # Returns number of pages
+    #
+    def page_count
+      pagination.page_count
+    end
+
+    # Returns collection of pages as a Hash:
+    # {
+    #   <page_number> => [<resource>, ...],
+    #   <page_number> => [<resource>, ...],
+    #   ...
+    # }
+    #
+    def pages
+      @pages ||= {}
+    end
+
+    # Returns i-th page
+    #
+    def page(i)
+      pages[i] ||= load_page(i)
+    end
+
+    # Loads i-th page
+    #
+    def load_page(i)
+      response = Cubits.connection.get(path_to, page: i)
+      @pagination = Hashie::Mash.new(response['pagination'])
+      response[collection_name].map { |r| resource.new r }
+    end
+
+    # Returns first page of the collection
+    #
+    def first_page
+      page(1)
+    end
+
+    # Returns last page of the collection
+    #
+    def last_page
+      page(page_count)
     end
   end # class ResourceCollection
 end # module Cubits

data/lib/cubits/version.rb

@@ -1,3 +1,3 @@
 module Cubits
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubits
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http