clever-ruby 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 4bb241ee16e9429513d5f73121b0ba2d422219a2
-  data.tar.gz: 57d5a3e97eed2e039ff0af060e78118086403509
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTI0OGY0NTY3MDg0ODc1NGE0OTJlNmE1NGQxMjVmZGJlNGFjMzFlMA==
+  data.tar.gz: !binary |-
+    ZTJjNGFhNTlkZTMxYWM0NjMxNjVjOGZmNmI1NjUyMTg4ZjIwZWI0YQ==
 SHA512:
-  metadata.gz: c5ad379292df7b04672d323a37d4472d9465a2aafa50e1d82fbacf6c637540b7e08dbf714483ab3003bff3e3f78481c1e30e9eaeb53f19c37159bbcc58682875
-  data.tar.gz: b4e6f23589a1a7add9041fbf2a151e3f7b5a80458576196552a882d5cc02ca88877cffaef2d47a614bbb3d2d078014e5d0856834087ad5bb0c334a17c685afb5
+  metadata.gz: !binary |-
+    NGNiNGM5OGM3ZjYwNjYyZGIyMmZlM2VjZmFmNWQxNjdhMjBmY2M1ZDBlMDY0
+    NWZhZTM4MTE3MmIyOTkxNTQ0ODdhODAxODVhNGI0N2U1OGY3NjdhMWM1Njc3
+    ZTlmZTY0NjQxZjUyNTliNGRiZjI1MTIzZDllYzRiNDU2MjVjOWM=
+  data.tar.gz: !binary |-
+    NGZjMjNkYjgxNGQxYWE0NWY2MGZkNjgzNzZmMThlZDIyZGI5MTk3OTcwMzI2
+    OTJlZGMwZjQwZjI1NDMyNjVjZGZjN2E3ZTVhMDMyNzg3OWVjOGM1NGViNTBk
+    MzdkNWE3ODhkZGExZGVlNzk4NWMyZGYwMDQwOGE5NjlkMDUyOTY=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.0 (2014-09-09)
+
+* Add ActiveRecord-style find and count methods to all APIResources (#37)
+
 ## 0.5.0 (2014-09-09)
 
 * Handle pagination through rel links, not manual numeric pagination (#36)

data/README.md

@@ -60,6 +60,6 @@ end
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git add -p ./path/to/files; git commit -m 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/lib/clever-ruby.rb

@@ -11,6 +11,7 @@ require 'clever-ruby/version'
 # API operations
 require 'clever-ruby/api_operations/list'
 require 'clever-ruby/api_operations/pagelist'
+require 'clever-ruby/api_operations/results_list'
 require 'clever-ruby/api_operations/page'
 
 # Helpers

data/lib/clever-ruby/api_operations/list.rb

@@ -11,6 +11,30 @@ module Clever
           end
           accum
         end
+
+        def find(id = nil, filters = {})
+          if id.is_a? Array
+            unless id.select { |e| !Clever::Util.valid_id? e }.empty?
+              fail ArgumentError, 'Array of IDs must only contain valid ObjectIDs'
+            end
+
+            filters[:where] = JSON.dump(_id: { :'$in' => id })
+          end
+
+          if id.nil? || id.is_a?(Array)
+            Clever::APIOperations::PageList.new(url, filters).to_results_list
+          elsif Clever::Util.valid_id? id
+            retrieve id
+          else
+            fail ArgumentError, 'id must be a valid ObjectID, an array of them, or nil.'
+          end
+        end
+
+        def count(filters = {})
+          filters[:count] = true
+          response = Clever.request :get, url, filters
+          response[:count]
+        end
       end
 
       def self.included(base)

data/lib/clever-ruby/api_operations/pagelist.rb

@@ -1,9 +1,9 @@
 module Clever
   module APIOperations
     # Handles paginated requests.
-    # TODO: use rel links
-    # TODO: build functionality elsewhere
     class PageList
+      include Enumerable
+
       def initialize(uri, filters = {})
         @uri = uri
         @filters = filters
@@ -16,6 +16,10 @@ module Clever
           page = page.next
         end
       end
+
+      def to_results_list
+        Clever::APIOperations::ResultsList.new self
+      end
     end
   end
 end

data/lib/clever-ruby/api_operations/results_list.rb

@@ -0,0 +1,20 @@
+module Clever
+  module APIOperations
+    # Represents a list of results for a paged request.
+    class ResultsList
+      include Enumerable
+
+      def initialize(pagelist)
+        @pages = pagelist
+      end
+
+      def each
+        @pages.each do |page|
+          page.each do |elem|
+            yield elem
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clever-ruby/util.rb

@@ -1,6 +1,10 @@
 module Clever
   # LibraryhHelper methods
   module Util
+    def self.valid_id?(id)
+      id.is_a?(String) && !(/^[0-9a-fA-F]{24}$/.match(id).nil?)
+    end
+
     def self.objects_to_ids(h)
       case h
       when APIResource

data/lib/clever-ruby/version.rb

@@ -1,4 +1,4 @@
 # Clever Ruby library
 module Clever
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/test/data/vcr_cassettes/district_count.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts?count=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:49 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '71'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"count":1,"links":[{"rel":"self","uri":"/v1.1/districts?count=true"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:49 GMT
+recorded_with: VCR 2.4.0

data/test/data/vcr_cassettes/district_find_by_page.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:53 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '217'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"paging":{"current":1,"total":1,"count":1},"links":[{"rel":"self","uri":"/v1.1/districts"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:53 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts?count=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:53 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '71'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"count":1,"links":[{"rel":"self","uri":"/v1.1/districts?count=true"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:53 GMT
+recorded_with: VCR 2.4.0

data/test/data/vcr_cassettes/district_find_multiple.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts?limit=20
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:53 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '226'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"paging":{"current":1,"total":1,"count":1},"links":[{"rel":"self","uri":"/v1.1/districts?limit=20"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:53 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts?where=%7B%22_id%22:%7B%22$in%22:%5B%224fd43cc56d11340000000005%22%5D%7D%7D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:53 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '288'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"paging":{"current":1,"total":1,"count":1},"links":[{"rel":"self","uri":"/v1.1/districts?where=%7B%22_id%22:%7B%22$in%22:[%224fd43cc56d11340000000005%22]%7D%7D"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:53 GMT
+recorded_with: VCR 2.4.0

data/test/data/vcr_cassettes/district_find_one.yml

@@ -0,0 +1,85 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:51 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '217'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"uri":"/v1.1/districts/4fd43cc56d11340000000005"}],"paging":{"current":1,"total":1,"count":1},"links":[{"rel":"self","uri":"/v1.1/districts"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:51 GMT
+- request:
+    method: get
+    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts/4fd43cc56d11340000000005
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type,Authorization,X-Requested-With,Accept,Origin,Referer,User-Agent
+      Access-Control-Allow-Methods:
+      - GET,PATCH,POST,DELETE
+      Access-Control-Allow-Origin:
+      - "*"
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 09 Sep 2014 21:48:51 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '518'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":{"name":"Demo District","id":"4fd43cc56d11340000000005"},"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005"},{"rel":"schools","uri":"/v1.1/districts/4fd43cc56d11340000000005/schools"},{"rel":"teachers","uri":"/v1.1/districts/4fd43cc56d11340000000005/teachers"},{"rel":"students","uri":"/v1.1/districts/4fd43cc56d11340000000005/students"},{"rel":"sections","uri":"/v1.1/districts/4fd43cc56d11340000000005/sections"},{"rel":"events","uri":"/v1.1/districts/4fd43cc56d11340000000005/events"}]}'
+    http_version: 
+  recorded_at: Tue, 09 Sep 2014 21:48:51 GMT
+recorded_with: VCR 2.4.0