arbor 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef88472480a661ea860c484d64e75f9884a2d171
-  data.tar.gz: 13885de2ac13295ab06788ece47856b6502cf1af
+  metadata.gz: 6b4a455a9b06989723d91f8d5419b8e4d1eaa731
+  data.tar.gz: 9058985b086831ec3c748bf57f876318607aa216
 SHA512:
-  metadata.gz: a19f952f616fb95da9c16d36bf6a4b67d87bf1051096fedd5bf3c11714bdea34611f2277cab870c369276ecaa2f0a4d9aecd466c1eb8fa8b566ad9635c8adbcd
-  data.tar.gz: ec4b7ba338c051f2d8020bdc4b40e8fc705dc14a3d088aba5724f58fe3eff1e5063c1fa3cfe06fee7218020cf7ce6ad38471794bf2458f9deccc4f6f1a60e00d
+  metadata.gz: 6f6971c9eb5ad2bb2812c33092c97122af8cdfa377e6fb732948843ef580c39c9b5385d109c2d39d416c5417485de9f8983ab6b7200a54bb0da196b0dd8a9ee3
+  data.tar.gz: 1e811aeb1400e1a056d180668e4929ad37d46421b09c9bac38aff600e8ad195122d23b603f8b4f906c4599b3d899eb39b1c6a3b1fa0c338032a60a23973e078e

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Interface for Arbor API
 
-A Ruby interface to [Arbor Education API](http://www.arbor-education.com/developers.html).
+An unofficial Ruby interface to [Arbor Education API](http://www.arbor-education.com/developers.html).
 
 ## Installation
 

data/lib/arbor/api.rb

@@ -3,30 +3,30 @@ require 'arbor/model/serialiser'
 module Arbor
   module API
     def retrieve(type, id)
-      resource = parse_resource(type)
-      data = get("/rest-v2/#{resource}/#{id}")
+      resource = parse_resource_name(type)
+      data = get("/rest-v2/#{resource.dasherize}/#{id}")
 
       unmarshall_data(data, resource)
     end
 
     def query(type, query = nil)
-      resource = parse_resource(type)
+      resource = parse_resource_name(type)
       query_string = query.build_query_string if query
 
-      data = get("/rest-v2/#{resource}?#{query_string}")
+      data = get("/rest-v2/#{resource.dasherize}?#{query_string}")
 
       unmarshall_data(data, resource)
     end
 
     private
       def unmarshall_data(data, resource)
-        singular_resource = resource.to_s.singularize
-        plural_resource   = resource.to_s
+        singular_resource = resource.singularize.camelize(:lower)
+        plural_resource   = resource.camelize(:lower)
 
         if (res = data[singular_resource])
           Model::Serialiser.parse_resource(res).tap { |obj|
             obj.attach_client(self) if obj.respond_to?(:attach_client)
-            obj.lock_attributes = true
+            obj.lock_attributes = true if obj.respond_to?(:lock_attributes)
           }
         elsif data[plural_resource]
           data[plural_resource].map do |res|
@@ -34,8 +34,12 @@ module Arbor
               obj.attach_client(self) if obj.respond_to?(:attach_client)
             }
           end
+        elsif data.empty?
+          []
+        elsif data["errors"]
+          raise Errors::APIError, "#{data["status"]["code"]} #{data["status"]["reason"]}: #{data["status"]["errors"].join(", ")}"
         else
-          raise Errors::SerialisationError, "Unexpected root key in API data."
+          raise Errors::SerialisationError, "Unexpected root key in API data. Expected: #{plural_resource} or #{singular_resource}. Actual: #{data.keys}"
         end
       end
   end

data/lib/arbor/errors.rb

@@ -1,6 +1,7 @@
 module Arbor
   module Errors
-    SerialisationError = Class.new(StandardError)
+    SerialisationError    = Class.new(StandardError)
     UnknownAttributeError = Class.new(StandardError)
+    APIError              = Class.new(StandardError)
   end
 end

data/lib/arbor/model/abstract.rb

@@ -24,7 +24,7 @@ module Arbor
 
         data = api_client.get(href)
 
-        parsed_attributes = Serialiser.parse_attributes(data[entity_type.downcase])
+        parsed_attributes = Serialiser.parse_attributes(data[entity_type.camelize(:lower)])
         load_attributes(parsed_attributes)
         attach_client(self.api_client)
 
@@ -64,6 +64,14 @@ module Arbor
       def unlock_attributes
         @attribute_lock = false
       end
+
+      def attributes
+        Hash[attribute_names.map { |a| [a, send(a)] }]
+      end
+
+      def inspect
+        "#<#{self.class.name} #{attribute_names.map { |a| "#{a}: #{send(a).inspect}" }.join(', ')}>"
+      end
     end
   end
 end

data/lib/arbor/query.rb

@@ -1,15 +1,11 @@
 require 'uri'
-require 'arbor/utils'
 require 'arbor/filter'
 
 module Arbor
   class Query
-    include Arbor::Utils
-
     attr_accessor :filters, :resource
 
-    def initialize(type, filters = [])
-      @resource = parse_resource(type)
+    def initialize(filters = [])
       @filters = filters
     end
 

data/lib/arbor/utils.rb

@@ -2,21 +2,22 @@ require 'active_support/core_ext/string'
 
 module Arbor
   module Utils
-    def parse_resource(type)
-      validate(get_resource(type), Arbor::RESOURCES)
+    def parse_resource_name(type)
+      validate(get_resource_name(type), Arbor::RESOURCES)
     end
 
-    def get_resource(type)
+    def get_resource_name(type)
       case type
       when Class
-        type.name.pluralize.underscore.to_sym
+        # do reverse serialiser lookup instead
+        type.name.pluralize.underscore
       else
-        type.to_s.pluralize.to_sym
+        type.to_s.pluralize
       end
     end
 
     def validate(choice, options)
-      unless options.include?(choice)
+      unless options.include?(choice.to_sym)
         raise ArgumentError, "#{choice} is not a valid option: #{options}"
       end
       choice

data/lib/arbor/version.rb

@@ -1,3 +1,3 @@
 module Arbor
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arbor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport