clever-ruby 0.8.0 → 0.9.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTg5ZDQyM2U1NTU1N2JkOWEwYWNjN2FlNmIyOTRjM2Q3NWJlZTQ4YQ==
-  data.tar.gz: !binary |-
-    NzA5MDg3ODc0YzNkYmI5ZDZlN2NlYzU2ZGQyYjNmZjZiZjIyYmQ0Ng==
+SHA1:
+  metadata.gz: 72240221ff70715106fd5d8c9a1a729e22ac6151
+  data.tar.gz: aa22601ec563ecd02478f61772b788e1d1fd22fb
 SHA512:
-  metadata.gz: !binary |-
-    MDYzNDBmNjFlYTM4Mjc1Yjk4MmM2ZThjNzgzZDdiYzI2YzAxMjIwY2E1Mzhl
-    YjlkZTZhNjI5NjM1YmZjZDg2NzNlZWIyZGJjMzVmMjYwOWIyYTNkOTNiZGY1
-    NGQwNzA4MzhiNjk0ODc5YzUyNmExM2M1MGQyMWUwYzcyM2IyZWE=
-  data.tar.gz: !binary |-
-    NTMwNTI0M2UxODcxNThkYWJkOWEwMmZmNWIxNTY4NjI5YTZiNzE4MGRhMzBi
-    ZjExYjQ1ZGY1MThjNmQyNTEzNDc5M2E2MWEzM2VmMjU3NzU1MzNiMzVmOGVi
-    NjZmYTY3Y2QzZTBkOGJkNjA2OTFmMzFhY2U0MDRlM2MxNTA1YTE=
+  metadata.gz: 748147377f319880ae59d5998bea552e4059cd64e23bf53467b970b533441f2fdb91c90a3f102a5866ea461b90ab98d8bbf5a58db9325ab6185c1d9256b2b4be
+  data.tar.gz: 4afb8665b6a1852a54a581b3370efce8f6b1a9176a761b438cc2e7a650147dbf638e22e1894d1de11ab0f888fcc58321a0322fc2d4a6c1d67f39ec9a3d0ce127

data/lib/clever-ruby.rb

@@ -149,11 +149,12 @@ module Clever
   # @api private
   # @return [nil]
   # @raise [AuthenticationError] Error if no authentication present
-  def self.check_authorization
-    unless Clever.api_key || Clever.token
+  def self.check_authorization(headers)
+    unless Clever.api_key || Clever.token || headers.key?(:Authorization)
       fail AuthenticationError, 'No API key provided. (HINT: set your API key using '\
         '"Clever.configure { |config| config.api_key = <API-KEY> }" or your token using '\
-        '"Clever.configure { |config| config.token = <TOKEN> }")'
+        '"Clever.configure { |config| config.token = <TOKEN> }" '\
+        'or pass the district token as a second argument to retrieve)'
     end
   end
 
@@ -166,7 +167,7 @@ module Clever
   # @return [Hash] parsed JSON response
   # @raise [APIError] Error if API fails to return valid JSON
   def self.request(method, url, params = nil, headers = {})
-    check_authorization
+    check_authorization(headers)
     opts = create_request_opts method, url, params, headers
     response = execute_request opts
 

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

@@ -1,4 +1,5 @@
 module Clever
+  # API Operations
   module APIOperations
     # A list of API resource instances
     module List
@@ -13,9 +14,9 @@ module Clever
         # @return [Array] array of all elements matching the request
         # @example
         #   Clever::District.all
-        def all(filters = {})
+        def all(filters = {}, headers = {})
           accum = []
-          Clever::APIOperations::PageList.new(url, filters).each do |page|
+          Clever::APIOperations::PageList.new(url, filters, headers).each do |page|
             accum += page.all
           end
           accum
@@ -40,7 +41,7 @@ module Clever
         #   # Get districts with given ids
         #   ids = ['...', '...']
         #   districts = Clever::District.find ids
-        def find(id = nil, filters = {})
+        def find(id = nil, filters = {}, headers = {})
           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'
@@ -50,7 +51,7 @@ module Clever
           end
 
           if id.nil? || id.is_a?(Array)
-            Clever::APIOperations::PageList.new(url, filters).to_results_list
+            Clever::APIOperations::PageList.new(url, filters, headers).to_results_list
           elsif Clever::Util.valid_id? id
             retrieve id
           else
@@ -70,14 +71,14 @@ module Clever
         #   first_elems.each do |e|
         #     puts e.name
         #   end
-        def first(num = nil, filters = {})
+        def first(num = nil, filters = {}, headers = {})
           if num.nil?
             filters[:limit] = 1
-            response = Clever.request :get, url, filters
+            response = Clever.request :get, url, filters, headers
             Util.convert_to_clever_object response[:data].last
           else
             filters[:limit] = num
-            Clever::APIOperations::PageList.new(url, filters).first
+            Clever::APIOperations::PageList.new(url, filters, headers).first
           end
         end
 
@@ -93,15 +94,15 @@ module Clever
         #   last_elems.each do |e|
         #     puts e.name
         #   end
-        def last(num = nil, filters = {})
+        def last(num = nil, filters = {}, headers = {})
           filters[:ending_before] = 'last'
           if num.nil?
             filters[:limit] = 1
-            response = Clever.request :get, url, filters
+            response = Clever.request :get, url, filters, headers
             Util.convert_to_clever_object response[:data].last
           else
             filters[:limit] = num
-            Clever::APIOperations::PageList.new(url, filters).to_results_list
+            Clever::APIOperations::PageList.new(url, filters, headers).to_results_list
           end
         end
 
@@ -117,15 +118,15 @@ module Clever
         #   last_elems.each do |e|
         #     puts e.name
         #   end
-        def last(num = nil, filters = {})
+        def last(num = nil, filters = {}, headers = {})
           filters[:ending_before] = 'last'
           if num.nil?
             filters[:limit] = 1
-            response = Clever.request :get, url, filters
+            response = Clever.request :get, url, filters, headers
             Util.convert_to_clever_object response[:data].last
           else
             filters[:limit] = num
-            Clever::APIOperations::PageList.new(url, filters).to_results_list
+            Clever::APIOperations::PageList.new(url, filters, headers).to_results_list
           end
         end
 
@@ -135,9 +136,9 @@ module Clever
         # @return [Integer] Number of elements matching
         # @example
         #   num_districts = Clever::District.count
-        def count(filters = {})
+        def count(filters = {}, headers = {})
           filters[:count] = true
-          response = Clever.request :get, url, filters
+          response = Clever.request :get, url, filters, headers
           response[:count]
         end
       end

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

@@ -25,7 +25,7 @@ module Clever
       #   end
       def find(filters = {})
         filters = @filters.merge filters
-        Clever::APIOperations::PageList.new(@uri, filters).to_results_list
+        Clever::APIOperations::PageList.new(@uri, filters, headers).to_results_list
       end
 
       # Request the number of elements in a nested list from the API
@@ -39,7 +39,7 @@ module Clever
       def count(filters = {})
         filters = @filters.merge filters
         filters[:count] = true
-        response = Clever.request :get, @uri, filters
+        response = Clever.request :get, @uri, filters, headers
         response[:count]
       end
 
@@ -59,11 +59,11 @@ module Clever
         filters = @filters.merge filters
         if num.nil?
           filters[:limit] = 1
-          response = Clever.request :get, url, filters
+          response = Clever.request :get, url, filters, headers
           Util.convert_to_clever_object response[:data].last
         else
           filters[:limit] = num
-          Clever::APIOperations::PageList.new(url, filters).first
+          Clever::APIOperations::PageList.new(url, filters, headers).first
         end
       end
 
@@ -83,11 +83,11 @@ module Clever
         filters[:ending_before] = 'last'
         if num.nil?
           filters[:limit] = 1
-          response = Clever.request :get, @uri, filters
+          response = Clever.request :get, @uri, filters, headers
           Util.convert_to_clever_object response[:data].last
         else
           filters[:limit] = num
-          Clever::APIOperations::PageList.new(@uri, filters).to_results_list
+          Clever::APIOperations::PageList.new(@uri, filters, headers).to_results_list
         end
       end
     end

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

@@ -9,11 +9,12 @@ module Clever
       # @return [Clever::APIOperations::Page]
       # @example
       #   page = Page.new '/v1.1/districts'
-      def initialize(uri, filters = {})
+      def initialize(uri, filters = {}, headers = {})
         @uri = uri
         @filters = filters
+        @headers = headers
 
-        response = Clever.request :get, uri, filters
+        response = Clever.request :get, uri, filters, @headers
         @all = Util.convert_to_clever_object response[:data]
         @links = {}
         response[:links].each do |link|
@@ -29,7 +30,7 @@ module Clever
       #   unless next_page.nil?
       #     next_page.each do |elem| puts elem; end
       def next
-        @links.key?(:next) ? Page.new(@links[:next]) : nil
+        @links.key?(:next) ? Page.new(@links[:next], {}, @headers) : nil
       end
 
       # Iterate over all elements in the page

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

@@ -7,9 +7,10 @@ module Clever
       # Create a new PageList, without making any requests immediately
       # @api private
       # @return [PageList]
-      def initialize(uri, filters = {})
+      def initialize(uri, filters = {}, headers = {})
         @uri = uri
         @filters = filters
+        @headers = headers
       end
 
       # Iterate through each page, making requests as you iterate
@@ -22,7 +23,7 @@ module Clever
       #     end
       #   end
       def each
-        page = Page.new @uri, @filters
+        page = Page.new @uri, @filters, @headers
         until page.nil?
           yield page
           page = page.next

data/lib/clever-ruby/api_resource.rb

@@ -68,7 +68,7 @@ module Clever
     # @api private
     # @return [APIResource] The updated resource instance
     def refresh
-      response = Clever.request :get, url
+      response = Clever.request :get, url, nil, headers
       refresh_from response[:data]
 
       @links = response[:links].map do
@@ -89,8 +89,8 @@ module Clever
     # @example
     #   id = '...'
     #   district = Clever::District.retrieve id
-    def self.retrieve(id)
-      instance = new id
+    def self.retrieve(id, auth_token = nil)
+      instance = new id, auth_token
       instance.refresh
       instance
     end
@@ -107,21 +107,21 @@ module Clever
     # @abstract
     # @api private
     # @return [APIResource]
-    def initialize(id)
-      super id
+    def initialize(id, auth_token = nil)
+      super id, auth_token
       return if self.class.linked_resources.nil?
 
       self.class.linked_resources.each do |resource|
         if Clever::Util.singular? resource.to_s
           # Get single resource
           self.class.send :define_method, resource do
-            response = Clever.request :get, get_link_uri(resource)
+            response = Clever.request :get, get_link_uri(resource), {}, headers
             return Util.convert_to_clever_object response
           end
         else
           # Get list of nested resources
           self.class.send :define_method, resource do |filters = {}|
-            Clever::NestedResource.new get_link_uri(resource), filters
+            Clever::NestedResource.new get_link_uri(resource), filters, headers
           end
         end
       end

data/lib/clever-ruby/clever_object.rb

@@ -1,6 +1,6 @@
 module Clever
   # An instance of an APIResource's contents
-  class CleverObject
+  class CleverObject              # rubocop: disable ClassLength
     include Enumerable
 
     # TODO: fix this
@@ -15,9 +15,10 @@ module Clever
     # @api private
     # @param id [String, Hash] id, or values to instantiate from
     # @return [CleverObject] resource instance
-    def initialize(id = nil)
+    def initialize(id = nil, auth_token = nil)
       @values = {}
       @values[:id] = id if id
+      @values[:auth_token] = auth_token if auth_token
     end
 
     # Construct a CleverObject from the values it should contain. Requires :id
@@ -55,7 +56,7 @@ module Clever
     # @param partial [Boolean] whether to replace existing keys or start fresh
     # @return [CleverObject]
     def refresh_from(values, partial = false)
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      removed = partial ? Set.new : Set.new(@values.keys - [:auth_token] - values.keys)
       added = Set.new(values.keys - @values.keys)
 
       instance_eval do
@@ -73,6 +74,17 @@ module Clever
       end
     end
 
+    # Returns the headers needed to authorize subsequent requests
+    # @api  private
+    # @return [Object] Authorization header with this auth_token
+    def headers
+      if @values.key? :auth_token
+        { Authorization: 'Bearer ' + @values[:auth_token] }
+      else
+        {}
+      end
+    end
+
     # Access a value by key
     # @api public
     # @param k [String, Symbol] Key to access

data/lib/clever-ruby/district.rb

@@ -39,7 +39,9 @@ module Clever
     # TODO: remove
     [:school_pages, :teacher_pages, :section_pages, :student_pages, :event_pages].each do |name|
       define_method(name) do |filters = {}|
-        Clever::APIOperations::PageList.new get_link_uri(name.to_s.gsub('_page', '')), filters
+        Clever::APIOperations::PageList.new get_link_uri(name.to_s.gsub('_page', '')),
+                                            filters,
+                                            headers
       end
     end
   end

data/lib/clever-ruby/errors/api_connection_error.rb

@@ -1,4 +1,5 @@
 module Clever
+  # API Connection Error
   class APIConnectionError < CleverError
   end
 end

data/lib/clever-ruby/errors/api_error.rb

@@ -1,4 +1,5 @@
 module Clever
+  # API Error
   class APIError < CleverError
   end
 end

data/lib/clever-ruby/errors/authentication_error.rb

@@ -1,4 +1,5 @@
 module Clever
+  # Authentication Error
   class AuthenticationError < CleverError
   end
 end

data/lib/clever-ruby/nested_resource.rb

@@ -7,10 +7,11 @@ module Clever
     # Create a nested resource
     # @api private
     # @return [Clever::APIOperations::NestedList]
-    def initialize(uri, filters = {})
+    def initialize(uri, filters = {}, headers = {})
       @uri = uri
       @filters = filters
-      @results_list = Clever::APIOperations::PageList.new(uri, filters).to_results_list
+      @headers = headers
+      @results_list = Clever::APIOperations::PageList.new(uri, filters, headers).to_results_list
     end
 
     # Query and iterate over results for the params provided during initialization

data/lib/clever-ruby/version.rb

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

data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_events.yml

@@ -0,0 +1,132 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.clever.com/v1.1/districts/4fd43cc56d11340000000005?
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
+      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, 30 Sep 2014 20:13:24 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, 30 Sep 2014 20:13:25 GMT
+- request:
+    method: get
+    uri: https://api.clever.com//v1.1/districts/4fd43cc56d11340000000005/events?limit=100000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
+      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, 30 Sep 2014 20:13:25 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '148'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[],"paging":{"current":0,"total":0,"count":0},"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005/events?limit=100000"}]}'
+    http_version: 
+  recorded_at: Tue, 30 Sep 2014 20:13:25 GMT
+- request:
+    method: get
+    uri: https://api.clever.com//v1.1/districts/4fd43cc56d11340000000005/events?limit=2
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Authorization:
+      - Bearer DEMO_TOKEN
+      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, 30 Sep 2014 20:13:25 GMT
+      Server:
+      - nginx/1.4.7
+      X-Powered-By:
+      - Express
+      Content-Length:
+      - '143'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"data":[],"paging":{"current":0,"total":0,"count":0},"links":[{"rel":"self","uri":"/v1.1/districts/4fd43cc56d11340000000005/events?limit=2"}]}'
+    http_version: 
+  recorded_at: Tue, 30 Sep 2014 20:13:25 GMT
+recorded_with: VCR 2.9.3