clever-ruby 0.7.0 → 0.8.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTMxM2FkNGQzYzQ0YTJjZjE0YzhkMGM0ZDAyNjg2MTg3MjFlYzU0Ng==
+    YTg5ZDQyM2U1NTU1N2JkOWEwYWNjN2FlNmIyOTRjM2Q3NWJlZTQ4YQ==
   data.tar.gz: !binary |-
-    NDgzOWE5NzdhZjM2NWY4YjQyNzU1ZjY1NWQ5YThiZDlkM2IzNzgyYg==
+    NzA5MDg3ODc0YzNkYmI5ZDZlN2NlYzU2ZGQyYjNmZjZiZjIyYmQ0Ng==
 SHA512:
   metadata.gz: !binary |-
-    ODIyYTg2NTQwOTA4YWUyNjgxNjhhNjU3ZTk1YWNhYmMyZTA3NjYzM2NhZGJj
-    NGI2YWJlOTkyZTFhMTI0ZjlmN2U2MzExNzgyYjliY2JmN2Y1YzZhM2NmZjk0
-    ZjY2MjgzODk0ZWNiOTM3YjI5N2EyNDUxZmY5MTIxYTlmNTM0YTA=
+    MDYzNDBmNjFlYTM4Mjc1Yjk4MmM2ZThjNzgzZDdiYzI2YzAxMjIwY2E1Mzhl
+    YjlkZTZhNjI5NjM1YmZjZDg2NzNlZWIyZGJjMzVmMjYwOWIyYTNkOTNiZGY1
+    NGQwNzA4MzhiNjk0ODc5YzUyNmExM2M1MGQyMWUwYzcyM2IyZWE=
   data.tar.gz: !binary |-
-    YjE5MzgwMTJiMWRjYTYyMjQ3N2MzOTMwM2VkODcxZTViZjdhNTkyYjM0Y2Iw
-    Y2FjMjE2MjI2ZGQ4MWFlNTkwZWVmMDMxZTM1ZTBkZDkzYTkwZTc1OGY1OGVj
-    NzNiOGFmN2U1OTNkYzhhMjAxNDg3ZWIzZjIwNzFiNWU3MDljZmU=
+    NTMwNTI0M2UxODcxNThkYWJkOWEwMmZmNWIxNTY4NjI5YTZiNzE4MGRhMzBi
+    ZjExYjQ1ZGY1MThjNmQyNTEzNDc5M2E2MWEzM2VmMjU3NzU1MzNiMzVmOGVi
+    NjZmYTY3Y2QzZTBkOGJkNjA2OTFmMzFhY2U0MDRlM2MxNTA1YTE=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.0 (2014-09-12)
+
+* Add last method to lists of results for all resources
+
 ## 0.7.0 (2014-09-12)
 
 * Make nested resources support full queries, including find and count

data/clever-ruby.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'yard',          '~> 0.8.7'
   gem.add_development_dependency 'yardstick',     '~> 0.9.9'
   gem.add_development_dependency 'redcarpet',     '~> 3.1.2'
-  gem.add_development_dependency 'vcr',           '~> 2.4.0'
+  gem.add_development_dependency 'vcr',           '~> 2.9.3'
+  gem.add_development_dependency 'minitest-vcr',  '~> 0.1.1'
   gem.add_development_dependency 'webmock',       '~> 1.9.0'
   gem.add_development_dependency 'rubocop',       '~> 0.26.0'
 end

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

@@ -58,6 +58,77 @@ module Clever
           end
         end
 
+        # Query for the first element or n elements in the resource
+        # @api public
+        # @param num [nil, Integer] If nil, first elem; else, num elems to fetch
+        # @param filters [Hash] Filters to request with, as per Clever API spec
+        # @return [CleverObject, Clever::APIOperations::Page] elem, or
+        #   elems found.
+        # @example
+        #   first_elem = Clever::District.first
+        #   first_elems = Clever::District.first 20
+        #   first_elems.each do |e|
+        #     puts e.name
+        #   end
+        def first(num = nil, filters = {})
+          if num.nil?
+            filters[:limit] = 1
+            response = Clever.request :get, url, filters
+            Util.convert_to_clever_object response[:data].last
+          else
+            filters[:limit] = num
+            Clever::APIOperations::PageList.new(url, filters).first
+          end
+        end
+
+        # Query for the last element or n elements in the resource
+        # @api public
+        # @param num [nil, Integer] If nil, last elem; else, num elems to fetch
+        # @param filters [Hash] Filters to request with, as per Clever API spec
+        # @return [CleverObject, Clever::APIOperations::ResultsList] elem, or
+        #   elems found. If list, sorted in ascending order of ids.
+        # @example
+        #   last_elem = Clever::District.last
+        #   last_elems = Clever::District.last 20
+        #   last_elems.each do |e|
+        #     puts e.name
+        #   end
+        def last(num = nil, filters = {})
+          filters[:ending_before] = 'last'
+          if num.nil?
+            filters[:limit] = 1
+            response = Clever.request :get, url, filters
+            Util.convert_to_clever_object response[:data].last
+          else
+            filters[:limit] = num
+            Clever::APIOperations::PageList.new(url, filters).to_results_list
+          end
+        end
+
+        # Query for the last element or n elements in the resource
+        # @api public
+        # @param num [nil, Integer] If nil, last elem; else, num elems to fetch
+        # @param filters [Hash] Filters to request with, as per Clever API spec
+        # @return [CleverObject, Clever::APIOperations::ResultsList] elem, or
+        #   elems found. If list, sorted in ascending order of ids.
+        # @example
+        #   last_elem = Clever::District.last
+        #   last_elems = Clever::District.last 20
+        #   last_elems.each do |e|
+        #     puts e.name
+        #   end
+        def last(num = nil, filters = {})
+          filters[:ending_before] = 'last'
+          if num.nil?
+            filters[:limit] = 1
+            response = Clever.request :get, url, filters
+            Util.convert_to_clever_object response[:data].last
+          else
+            filters[:limit] = num
+            Clever::APIOperations::PageList.new(url, filters).to_results_list
+          end
+        end
+
         # Requests number of elements matching the query
         # @api public
         # @param filters [Hash, nil] Query parameters to pass, as per Clever API spec

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

@@ -1,6 +1,7 @@
 module Clever
   module APIOperations
     # Methods for interacting with the API on nested resources
+    # TODO: find a way to not duplicate list.rb code
     module NestedList
       # Query a nested list with Clever API params, overriding initialized keys
       # @api public
@@ -41,6 +42,54 @@ module Clever
         response = Clever.request :get, @uri, filters
         response[:count]
       end
+
+      # Query for the first element or n elements in the resource
+      # @api public
+      # @param num [nil, Integer] If nil, last elem; else, num elems to fetch
+      # @param filters [Hash] Filters to request with, as per Clever API spec
+      # @return [CleverObject, Clever::APIOperations::Page] elem, or
+      #   elems found. If list, sorted in ascending order of ids.
+      # @example
+      #   first_elem = Clever::District.first
+      #   first_elems = Clever::District.first 20
+      #   first_elems.each do |e|
+      #     puts e.name
+      #   end
+      def first(num = nil, filters = {})
+        filters = @filters.merge filters
+        if num.nil?
+          filters[:limit] = 1
+          response = Clever.request :get, url, filters
+          Util.convert_to_clever_object response[:data].last
+        else
+          filters[:limit] = num
+          Clever::APIOperations::PageList.new(url, filters).first
+        end
+      end
+
+      # Query for the last element or n elements in the resource
+      # @api public
+      # @param num [nil, Integer] If nil, last elem; else, num elems to fetch
+      # @return [CleverObject, Clever::APIOperations::ResultsList] elem, or
+      #   elems found. If list, sorted in ascending order of ids.
+      # @example
+      #   last_elem = Clever::District.last
+      #   last_elems = Clever::District.last 20
+      #   last_elems.each do |e|
+      #     puts e.name
+      #   end
+      def last(num = nil, filters = {})
+        filters = @filters.merge filters
+        filters[:ending_before] = 'last'
+        if num.nil?
+          filters[:limit] = 1
+          response = Clever.request :get, @uri, filters
+          Util.convert_to_clever_object response[:data].last
+        else
+          filters[:limit] = num
+          Clever::APIOperations::PageList.new(@uri, filters).to_results_list
+        end
+      end
     end
   end
 end

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

@@ -14,7 +14,7 @@ module Clever
         @filters = filters
 
         response = Clever.request :get, uri, filters
-        @list = Util.convert_to_clever_object response[:data]
+        @all = Util.convert_to_clever_object response[:data]
         @links = {}
         response[:links].each do |link|
           @links[link[:rel].to_sym] = link[:uri]
@@ -38,7 +38,7 @@ module Clever
       # @example
       #   page.each { |elem| puts elem }
       def each(&blk)
-        @list.each(&blk)
+        @all.each(&blk)
       end
 
       # Get all elements in page
@@ -46,12 +46,20 @@ module Clever
       # @return [Array] List of all elements
       # @example
       #   all_elems = page.all
-      def all
-        accum = []
-        each do |elem|
-          accum << elem
-        end
-        accum
+      attr_reader :all
+
+      # Retrieve the last element or n elements in the resource
+      # @api public
+      # @param num [nil, Integer] If nil, last elem; else, num elems to fetch
+      # @return [CleverObject, Clever::APIOperations::Page] elem, or
+      #   elems found. If list, sorted in ascending order of ids.
+      # @example
+      #   elems = Clever::District.first(20)
+      #   last_elem = elems.last
+      #   last_elems = elems.last 5
+      def last(num = nil)
+        return @all.last num if num
+        @all.last
       end
     end
   end

data/lib/clever-ruby/version.rb

@@ -1,4 +1,4 @@
 # Clever Ruby library
 module Clever
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/test/data/vcr_cassettes/{district_count.yml → Clever_APIOperations_List/counts_district_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts?count=true
+    uri: https://api.clever.com/v1.1/districts?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:32 GMT
+      - Sat, 13 Sep 2014 00:03:49 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":1,"links":[{"rel":"self","uri":"/v1.1/districts?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:32 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:03:49 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{event_count.yml → Clever_APIOperations_List/counts_event_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/events?count=true
+    uri: https://api.clever.com/v1.1/events?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:28 GMT
+      - Sat, 13 Sep 2014 00:05:05 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":7,"links":[{"rel":"self","uri":"/v1.1/events?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:28 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:05:05 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{school_count.yml → Clever_APIOperations_List/counts_school_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/schools?count=true
+    uri: https://api.clever.com/v1.1/schools?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:34 GMT
+      - Sat, 13 Sep 2014 00:02:46 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":3,"links":[{"rel":"self","uri":"/v1.1/schools?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:34 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:02:46 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{section_count.yml → Clever_APIOperations_List/counts_section_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/sections?count=true
+    uri: https://api.clever.com/v1.1/sections?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:28 GMT
+      - Sat, 13 Sep 2014 00:05:04 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":379,"links":[{"rel":"self","uri":"/v1.1/sections?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:28 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:05:04 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{student_count.yml → Clever_APIOperations_List/counts_student_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/students?count=true
+    uri: https://api.clever.com/v1.1/students?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:28 GMT
+      - Sat, 13 Sep 2014 00:05:02 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":1004,"links":[{"rel":"self","uri":"/v1.1/students?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:28 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:05:02 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{teacher_count.yml → Clever_APIOperations_List/counts_teacher_properly.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/teachers?count=true
+    uri: https://api.clever.com/v1.1/teachers?count=true
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:31 GMT
+      - Sat, 13 Sep 2014 00:02:46 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,5 +42,5 @@ http_interactions:
       encoding: US-ASCII
       string: ! '{"count":89,"links":[{"rel":"self","uri":"/v1.1/teachers?count=true"}]}'
     http_version: 
-  recorded_at: Fri, 12 Sep 2014 20:48:31 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:02:46 GMT
+recorded_with: VCR 2.9.3

data/test/data/vcr_cassettes/{district_find_one.yml → Clever_APIOperations_List/finds_a_single_district.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts
+    uri: https://api.clever.com/v1.1/districts
     body:
       encoding: US-ASCII
       string: ''
@@ -11,6 +11,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -27,7 +29,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:41 GMT
+      - Sat, 13 Sep 2014 00:04:54 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -40,10 +42,10 @@ http_interactions:
       encoding: US-ASCII
       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: Fri, 12 Sep 2014 20:48:41 GMT
+  recorded_at: Sat, 13 Sep 2014 00:04:54 GMT
 - request:
     method: get
-    uri: https://DEMO_KEY:@api.clever.com/v1.1/districts/4fd43cc56d11340000000005
+    uri: https://api.clever.com/v1.1/districts/4fd43cc56d11340000000005
     body:
       encoding: US-ASCII
       string: ''
@@ -52,6 +54,8 @@ http_interactions:
       - ! '*/*; q=0.5, application/xml'
       Accept-Encoding:
       - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
       User-Agent:
       - Ruby
   response:
@@ -68,7 +72,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Fri, 12 Sep 2014 20:48:41 GMT
+      - Sat, 13 Sep 2014 00:04:54 GMT
       Server:
       - nginx/1.4.7
       X-Powered-By:
@@ -81,5 +85,5 @@ http_interactions:
       encoding: US-ASCII
       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: Fri, 12 Sep 2014 20:48:41 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Sat, 13 Sep 2014 00:04:54 GMT
+recorded_with: VCR 2.9.3