clever-ruby 0.3.1 → 0.4.0

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

@@ -1,15 +1,20 @@
 module Clever
   module APIOperations
+    # A list of API resource instances
     module List
+      # Class methods for those that include List
       module ClassMethods
-        def all(filters={})
-          response = Clever.request(:get, url, filters)
-          Util.convert_to_clever_object(response[:data])
+        def all(filters = {})
+          accum = []
+          Clever::APIOperations::PageList.new(url, filters).each do |page|
+            accum += page.all
+          end
+          accum
         end
       end
 
       def self.included(base)
-        base.extend(ClassMethods)
+        base.extend ClassMethods
       end
     end
   end

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

@@ -1,19 +1,22 @@
 module Clever
   module APIOperations
+    # Represents a page of data
     class Page
       attr_accessor :paging
-      def initialize(uri, filters={})
+
+      def initialize(uri, filters = {})
         @uri = uri
         @filters = filters
 
-        response = Clever.request(:get, uri, filters)
-        @list = Util.convert_to_clever_object(response[:data])
+        response = Clever.request :get, uri, filters
+        @list = Util.convert_to_clever_object response[:data]
         self.paging = response[:paging]
       end
 
+      # rubocop:disable TrivialAccessors
       def all
         @list
       end
     end
   end
-end
+end

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

@@ -1,7 +1,10 @@
 module Clever
   module APIOperations
+    # Handles paginated requests.
+    # TODO: use rel links
+    # TODO: build functionality elsewhere
     class PageList
-      def initialize(uri, filters={})
+      def initialize(uri, filters = {})
         @uri = uri
         @filters = filters
       end
@@ -10,7 +13,7 @@ module Clever
         current = 0
         total = 1
         while current < total
-          page = Page.new(@uri, @filters.merge({ page: current + 1 }))
+          page = Page.new @uri, @filters.merge(page: current + 1)
 
           yield page
 
@@ -20,4 +23,4 @@ module Clever
       end
     end
   end
-end
+end

data/lib/clever-ruby/api_resource.rb

@@ -1,35 +1,56 @@
 module Clever
+  # Superclass of API resources in the Clever API
   class APIResource < CleverObject
     def self.url
       if self == APIResource
-        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (School, Student, etc.)')
+        fail NotImplementedError, 'APIResource is an abstract class. You should perform actions '\
+          'on its subclasses (School, Student, etc.)'
       end
-      shortname = self.name.split('::')[-1]
-      "v1.1/#{CGI.escape(shortname.downcase)}s"
+      shortname = name.split('::')[-1]
+      "v1.1/#{CGI.escape shortname.downcase}s"
     end
 
     def url
-      unless id = self['id']
-        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
+      id = self['id']
+      unless id
+        fail InvalidRequestError.new(
+          "Could not determine which URL to request: #{self.class} instance has " \
+          "invalid ID: #{id.inspect}", 'id')
       end
-      "#{self.class.url}/#{CGI.escape(id)}"
+      "#{self.class.url}/#{CGI.escape id}"
     end
 
     def refresh
-      response = Clever.request(:get, url)
-      refresh_from(response[:data])
+      response = Clever.request :get, url
+      refresh_from response[:data]
       self
     end
 
     def links
-      response = Clever.request(:get, url)
+      response = Clever.request :get, url
       response[:links]
     end
 
     def self.retrieve(id)
-      instance = self.new(id)
+      instance = new id
       instance.refresh
       instance
     end
+
+    def get_linked_resources(resource_type, filters = {})
+      Util.convert_to_clever_object Clever.request(:get, get_uri(resource_type), filters)[:data]
+    end
+
+    class << self; attr_reader :linked_resources; end
+    def initialize(id)
+      super id
+
+      resources = self.class.linked_resources || []
+      resources.each do |resource|
+        self.class.send :define_method, resource do |filters = {}|
+          get_linked_resources resource.to_s, filters
+        end
+      end
+    end
   end
 end

data/lib/clever-ruby/clever_object.rb

@@ -1,45 +1,46 @@
 module Clever
+  # An instance of an APIResource's contents
   class CleverObject
     include Enumerable
 
-    @@permanent_attributes = Set.new([])
+    # TODO: fix this
+    # rubocop:disable ClassVars
+    @@permanent_attributes = Set.new []
 
     # The default :id method is deprecated and isn't useful to us
-    if method_defined?(:id)
-      undef :id
-    end
+    undef :id if method_defined? :id
 
-    def initialize(id=nil)
+    def initialize(id = nil)
       @values = {}
       @values[:id] = id if id
     end
 
     def self.construct_from(values)
-      obj = self.new(values[:id])
-      obj.refresh_from(values)
+      obj = new values[:id]
+      obj.refresh_from values
       obj
     end
 
-    def to_s(*args)
-      Clever::JSON.dump(@values, :pretty => true)
+    def to_s
+      Clever::JSON.dump @values, pretty: true
     end
 
-    def inspect()
-      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
-      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + Clever::JSON.dump(@values, :pretty => true)
+    def inspect
+      id_string = (respond_to?(:id) && !id.nil?) ? " id=#{id}" : ''
+      "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " +
+        Clever::JSON.dump(@values, pretty: true)
     end
 
-    def refresh_from(values, partial=false)
-
+    def refresh_from(values, partial = false)
       removed = partial ? Set.new : Set.new(@values.keys - values.keys)
       added = Set.new(values.keys - @values.keys)
 
       instance_eval do
-        remove_accessors(removed)
-        add_accessors(added)
+        remove_accessors removed
+        add_accessors added
       end
       removed.each do |k|
-        @values.delete(k)
+        @values.delete k
       end
       values.each do |k, v|
         # Stripe apparently allows you to have nested object types (e.g.
@@ -50,12 +51,12 @@ module Clever
     end
 
     def [](k)
-      k = k.to_sym if k.kind_of?(String)
+      k = k.to_sym if k.is_a? String
       @values[k]
     end
 
     def []=(k, v)
-      send(:"#{k}=", v)
+      send :"#{k}=", v
     end
 
     def keys
@@ -66,8 +67,8 @@ module Clever
       @values.values
     end
 
-    def to_json(*a)
-      Clever::JSON.dump(@values)
+    def to_json
+      Clever::JSON.dump @values
     end
 
     def as_json(*a)
@@ -82,10 +83,8 @@ module Clever
       @values.each(&blk)
     end
 
-    def ==( other )
-      if other.respond_to?( :values )
-        self.values == other.values
-      end
+    def ==(other)
+      values == other.values if other.respond_to? :values
     end
 
     protected
@@ -97,10 +96,10 @@ module Clever
     def remove_accessors(keys)
       metaclass.instance_eval do
         keys.each do |k|
-          next if @@permanent_attributes.include?(k)
+          next if @@permanent_attributes.include? k
           k_eq = :"#{k}="
-          remove_method(k) if method_defined?(k)
-          remove_method(k_eq) if method_defined?(k_eq)
+          remove_method k if method_defined? k
+          remove_method k_eq if method_defined? k_eq
         end
       end
     end
@@ -108,23 +107,23 @@ module Clever
     def add_accessors(keys)
       metaclass.instance_eval do
         keys.each do |k|
-          next if @@permanent_attributes.include?(k)
+          next if @@permanent_attributes.include? k
           k_eq = :"#{k}="
           define_method(k) { @values[k] }
-          define_method(k_eq) do |v|
-            @values[k] = v
-          end
+          define_method(k_eq) { |v| @values[k] = v }
         end
       end
     end
 
     def optional_attributes
-      raise NotImplementedError.new('Please define #optional_attributes as a list of the attributes on this resource that may not be present and thus should return nil instead of raising a NoMethodError.')
+      fail NotImplementedError 'Please define #optional_attributes as a list of the '\
+        'attributes on this resource that may not be present and thus should return nil' \
+        'instead of raising a NoMethodError.'
     end
 
     def method_missing(name, *args)
-      return @values[name] if @values.has_key?(name)
-      return nil if optional_attributes.include?(name)
+      return @values[name] if @values.key? name
+      return nil if optional_attributes.include? name
       super
     end
   end

data/lib/clever-ruby/configuration.rb

@@ -1,4 +1,5 @@
 module Clever
+  # Configuration for accessing the Clever API over HTTP
   class Configuration
     attr_accessor :api_key, :token, :api_base
 
@@ -8,4 +9,4 @@ module Clever
       @api_base = 'https://api.clever.com/'
     end
   end
-end
+end

data/lib/clever-ruby/district.rb

@@ -1,33 +1,25 @@
 module Clever
+  # District resource
   class District < APIResource
     include Clever::APIOperations::List
+    @linked_resources = [:schools, :teachers, :sections, :students, :events]
 
     def optional_attributes
       # All of a district's attributes are required.
       []
     end
 
-    [:schools, :teachers, :sections, :students, :events].each do |name|
-      define_method(name) do |filters = {}|
-        get_linked_resources name.to_s, filters
-      end
-    end
-
     [:school_pages, :teacher_pages, :section_pages, :student_pages, :event_pages].each do |name|
       define_method(name) do |filters = {}|
-        Clever::APIOperations::PageList.new(get_uri(name.to_s.gsub('_page', '')), filters)
+        Clever::APIOperations::PageList.new get_uri(name.to_s.gsub('_page', '')), filters
       end
     end
 
     private
 
-    def get_linked_resources(resource_type, filters={})
-      Util.convert_to_clever_object(Clever.request(:get, get_uri(resource_type), filters)[:data])
-    end
-
     def get_uri(resource_type)
       refresh
-      links.detect {|link| link[:rel] == resource_type }[:uri]
+      links.find { |link| link[:rel] == resource_type }[:uri]
     end
   end
 end

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

@@ -1,4 +1,4 @@
 module Clever
   class APIConnectionError < CleverError
   end
-end
+end

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

@@ -1,4 +1,4 @@
 module Clever
   class APIError < CleverError
   end
-end
+end

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

@@ -1,4 +1,4 @@
 module Clever
   class AuthenticationError < CleverError
   end
-end
+end

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

@@ -1,11 +1,12 @@
 module Clever
+  # Represents an error outputted bythe Clever API
   class CleverError < StandardError
     attr_reader :message
     attr_reader :http_status
     attr_reader :http_body
     attr_reader :json_body
 
-    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+    def initialize(message = nil, http_status = nil, http_body = nil, json_body = nil)
       @message = message
       @http_status = http_status
       @http_body = http_body
@@ -13,8 +14,8 @@ module Clever
     end
 
     def to_s
-      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      status_string = @http_status.nil? ? '' : "(Status #{@http_status}) "
       "#{status_string}#{@message}"
     end
   end
-end
+end

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

@@ -1,10 +1,11 @@
 module Clever
+  # An invalid request to the Clever API
   class InvalidRequestError < CleverError
     attr_accessor :param
 
-    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
-      super(message, http_status, http_body, json_body)
+    def initialize(message, param, http_status = nil, http_body = nil, json_body = nil)
+      super message, http_status, http_body, json_body
       @param = param
     end
   end
-end
+end

data/lib/clever-ruby/event.rb

@@ -1,4 +1,5 @@
 module Clever
+  # Event resource
   class Event < APIResource
     include Clever::APIOperations::List
 
@@ -7,9 +8,9 @@ module Clever
     end
 
     def object
-      klass = Util.types_to_clever_class(type_pieces[0])
+      klass = Util.types_to_clever_class type_pieces[0]
       klass ||= CleverObject
-      klass.construct_from(data[:object])
+      klass.construct_from data[:object]
     end
 
     def previous_attributes
@@ -19,15 +20,15 @@ module Clever
     def action
       type_pieces[1]
     end
-    
+
     def self.url
-      "v1.1/events"
+      'v1.1/events'
     end
 
     private
 
     def type_pieces
-      type.split(".")
+      type.split '.'
     end
   end
 end

data/lib/clever-ruby/json.rb

@@ -1,6 +1,7 @@
 module Clever
+  # Helpers for handling JSON responses
   module JSON
-    if MultiJson.respond_to?(:dump)
+    if MultiJson.respond_to? :dump
       def self.dump(*args)
         MultiJson.dump(*args)
       end