badgeapi 0.3.10 → 1.0.0

data/lib/badgeapi/badgeapi_object.rb

@@ -1,149 +1,162 @@
-#lib/badgeapi/badgeapi_object.rb
-
+# lib/badgeapi/badgeapi_object.rb
 module Badgeapi
-	class BadgeapiObject
-
-		class << self
-
-			def collection_name
-				name.demodulize.pluralize.underscore
-			end
-			alias collection_path collection_name
-
-			def member_name
-				name.demodulize.underscore
-			end
-
-			def request method, url, params={}
-				#connection = Faraday.new(:ssl => {:verify => false})
-				connection = Faraday.new(:ssl => {
-					:ca_file => Badgeapi.ssl_ca_cert
-				})
-
-				connection.token_auth(Badgeapi.api_key)
-				from_response connection.send(method, url, params)
-			end
-
-			def from_response response
-				attributes = JSON.parse(response.body)
-
-				if attributes.include?("error")
-					handle_api_error attributes
-				else
-					if attributes.class == Array
-						attributes.map do |attributes|
-							map_json_to_object(attributes)
-						end
-					else
-						map_json_to_object attributes
-					end
-				end
-			end
-
-			def object_classes
-				@object_classes ||= {
-					'recipient' => Recipient,
-					'collection' => Collection,
-					'badge'=> Badge,
-					'required_badge'=>Badge
-				}
-			end
-
-			def map_json_to_object attributes
-				if attributes['object'] != nil
-					record = object_classes.fetch(attributes['object'].singularize).new
-				else
-					record = new
-				end
-
-				attributes.each do |name, value|
-					if object_classes.has_key?(name) || object_classes.has_key?(name.singularize)
-						child = map_related_object object_classes.fetch(name.singularize), value
-						record.instance_variable_set "@#{name}", child
-					else
-						record.instance_variable_set "@#{name}", value
-					end
-				end
-				record
-			end
-
-			def map_related_object object, attributes
-				if attributes.class == Array
-					attributes.map do |attributes|
-						map_related_object object, attributes
-					end
-				else
-					record = object.new
-					attributes.each do |name, value|
-						if value.class == Array && value.count > 0
-							if object_classes.has_key?(name) || object_classes.has_key?(name.singularize)
-								child = map_related_object object_classes.fetch(name.singularize), value
-								record.instance_variable_set "@#{name}", child
-							end
-						else
-							record.instance_variable_set "@#{name}", value
-						end
-					end
-					record
-				end
-			end
-
-			def find id, params ={}
-				request "get", "#{Badgeapi.api_url}/#{collection_path}/#{id}", params
-			end
-
-			def all params = {}
-				request "get", "#{Badgeapi.api_url}/#{collection_path}", params
-			end
-
-			def create params={}
-				request "post", "#{Badgeapi.api_url}/#{collection_path}", member_name => params
-			end
-
-			def update id, params = {}
-				request "patch", "#{Badgeapi.api_url}/#{collection_path}/#{id}", member_name => params
-			end
-
-			def destroy(id)
-				request "delete", "#{Badgeapi.api_url}/#{collection_path}/#{id}"
-			end
-
-		end
-
-		def inspect
-			id_as_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
-			"#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_as_string}> JSON: " + self.to_json
-		end
-
-		def save
-			# Remove params that cannot be saved as they are not permitted through strong_params on api
-			params = JSON.parse(self.to_json)
-
-			params.delete("id")
-			params.delete("created_at")
-			params.delete("updated_at")
-			params.delete("points")
-			params.delete("total_points_available")
-			params.delete("badge_count")
-			params.delete("object")
-
-			self.class.request "patch", "#{Badgeapi.api_url}/#{self.class.collection_path}/#{id}", self.class.member_name => params
-		end
-
-	private
-
-		def self.handle_api_error error
-			error_object = error['error']
-
-			case error_object["type"]
-				when "invalid_request_error"
-					raise InvalidRequestError.new(error_object["message"], error_object["status"], error)
-				when "api_error"
-					raise APIError.new(error_object["message"], error_object["status"], error)
-				else
-					raise APIError.new("Unknown error tyep #{error_object["type"]}", error_object["status"], error)
-			end
-		end
-
-	end
+  class BadgeapiObject
+    class << self
+      def collection_name
+        name.demodulize.pluralize.underscore
+      end
+      alias_method :collection_path, :collection_name
+
+      def member_name
+        name.demodulize.underscore
+      end
+
+      def request method, url, params = {}
+        connection = Faraday.new(ssl: { ca_file: Badgeapi.ssl_ca_cert })
+
+        connection.token_auth(Badgeapi.api_key)
+        from_response connection.send(method, url, params)
+      end
+
+      def from_response response
+        attributes = JSON.parse(response.body)
+
+        if attributes.include?("error")
+          handle_api_error attributes
+        else
+          if attributes.class == Array
+            attributes.map do |subattributes|
+              map_json_to_object(subattributes)
+            end
+          else
+            map_json_to_object attributes
+          end
+        end
+      end
+
+      def object_classes
+        @object_classes ||= {
+          'recipient'      => Recipient,
+          'collection'     => Collection,
+          'badge'          => Badge,
+          'required_badge' =>	Badge
+        }
+      end
+
+      def map_json_to_object attributes
+        if attributes['object'].nil?
+          record = new
+        else
+          record = object_classes.fetch(attributes['object'].singularize).new
+        end
+
+        map_instant_variables_to_record attributes, record
+        record
+      end
+
+      def map_instant_variables_to_record attributes, record
+        attributes.each do |name, value|
+          if attribute_a_badge_object? name
+            child = map_related_object object_classes.fetch(name.singularize), value
+            record.instance_variable_set "@#{name}", child
+          else
+            record.instance_variable_set "@#{name}", value
+          end
+        end
+      end
+
+      def map_related_object object, attributes
+        if attributes.class == Array
+          attributes.map do |subattributes|
+            # Recursion: loop through until every object is mapped
+            map_related_object object, subattributes
+          end
+        else
+          record = object.new
+          map_instant_variables_to_child_records attributes, record
+          record
+        end
+      end
+
+      def map_instant_variables_to_child_records attributes, record
+        attributes.each do |name, value|
+          if value.class == Array && value.count > 0
+            if attribute_a_badge_object? name
+              child = map_related_object object_classes.fetch(name.singularize), value
+              record.instance_variable_set "@#{name}", child
+            end
+          else
+            record.instance_variable_set "@#{name}", value
+          end
+        end
+      end
+
+      def attribute_a_badge_object? name
+        if object_classes.has_key?(name) || object_classes.has_key?(name.singularize)
+          true
+        else
+          false
+        end
+      end
+
+      def find id, params = {}
+        request "get", "#{Badgeapi.api_url}/#{collection_path}/#{id}", params
+      end
+
+      def all params = {}
+        request "get", "#{Badgeapi.api_url}/#{collection_path}", params
+      end
+
+      def create params = {}
+        request "post", "#{Badgeapi.api_url}/#{collection_path}", member_name => params
+      end
+
+      def update id, params = {}
+        request "patch", "#{Badgeapi.api_url}/#{collection_path}/#{id}", member_name => params
+      end
+
+      def destroy(id)
+        request "delete", "#{Badgeapi.api_url}/#{collection_path}/#{id}"
+      end
+    end
+
+    def inspect
+      id_as_string = (respond_to?(:id) && !id.nil?) ? " id=#{id}" : ""
+      "#<#{self.class}:0x#{object_id.to_s(16)}#{id_as_string}> JSON: " + to_json
+    end
+
+    def remove_read_only_params
+      # Remove params that cannot be saved as they are not permitted through strong_params on api
+      params = JSON.parse(to_json)
+
+      params.delete("id")
+      params.delete("created_at")
+      params.delete("updated_at")
+      params.delete("points")
+      params.delete("total_points_available")
+      params.delete("badge_count")
+      params.delete("object")
+    end
+
+    def save
+      # Remove params that cannot be saved as they are not permitted through strong_params on api
+      params = remove_read_only_params
+
+      self.class.request "patch", "#{Badgeapi.api_url}/#{self.class.collection_path}/#{id}",
+                         self.class.member_name => params
+    end
+
+    def self.handle_api_error error
+      error_object = error['error']
+
+      case error_object["type"]
+      when "invalid_request_error"
+        raise InvalidRequestError.new(error_object["message"], error_object["status"], error)
+      when "api_error"
+        raise APIError.new(error_object["message"], error_object["status"], error)
+      else
+        raise APIError.new("Unknown error tyep #{error_object['type']}", error_object["status"], error)
+      end
+    end
+  end
 end

data/lib/badgeapi/collection.rb

@@ -1,10 +1,7 @@
-#lib/badgeapi/collection.rb
-
+# lib/badgeapi/collection.rb
 module Badgeapi
-	class Collection < BadgeapiObject
-
-		attr_reader :id, :created_at, :updated_at, :badges, :total_points_available, :object, :badge_count
-		attr_accessor :name, :description
-
-	end
-end
+  class Collection < BadgeapiObject
+    attr_reader :id, :created_at, :updated_at, :badges, :total_points_available, :object, :badge_count
+    attr_accessor :name, :description
+  end
+end

data/lib/badgeapi/errors/api_error.rb

@@ -1,5 +1,4 @@
 module Badgeapi
-	class APIError < BadgeapiError
-
-	end
-end
+  class APIError < BadgeapiError
+  end
+end

data/lib/badgeapi/errors/badgeapi_error.rb

@@ -1,18 +1,18 @@
 module Badgeapi
-	class BadgeapiError < StandardError
-		attr_reader :message
-		attr_reader :http_status
-		attr_reader :json_body
+  class BadgeapiError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :json_body
 
-		def initialize(message=nil, http_status=nil, json_body=nil)
-			@message = message
-			@http_status = http_status
-			@json_body = json_body
-		end
+    def initialize(message = nil, http_status = nil, json_body = nil)
+      @message = message
+      @http_status = http_status
+      @json_body = json_body
+    end
 
-		def to_s
-			status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
-			"#{status_string}#{@message}"
-		end
-	end
-end
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/badgeapi/errors/invalid_request_error.rb

@@ -1,5 +1,4 @@
 module Badgeapi
-	class InvalidRequestError < BadgeapiError
-
-	end
-end
+  class InvalidRequestError < BadgeapiError
+  end
+end

data/lib/badgeapi/recipient.rb

@@ -1,18 +1,15 @@
-#lib/badgeapi/collection.rb
-
+# lib/badgeapi/collection.rb
 module Badgeapi
-	class Recipient < BadgeapiObject
-
-		attr_reader :total_score, :badges_total, :bronze_count, :silver_count, :gold_count, :platinum_count, :badges, :object, :username, :created_at, :updated_at
-
-		class << self
-
-			def find params = {}
-				request "get", "#{Badgeapi.api_url}/#{collection_path}", params
-			end
-
-			undef_method :all, :create, :update, :destroy
-		end
-
-	end
+  class Recipient < BadgeapiObject
+    attr_reader :total_score, :badges_total, :bronze_count, :silver_count, :gold_count, :platinum_count, :badges,
+                :object, :username, :created_at, :updated_at
+
+    class << self
+      def find params = {}
+        request "get", "#{Badgeapi.api_url}/#{collection_path}", params
+      end
+
+      undef_method :all, :create, :update, :destroy
+    end
+  end
 end

data/lib/badgeapi/version.rb

@@ -1,3 +1,3 @@
 module Badgeapi
-  VERSION = "0.3.10"
+  VERSION = "1.0.0"
 end

data/lib/badgeapi.rb

@@ -14,23 +14,21 @@ require_relative "badgeapi/errors/api_error"
 require_relative "badgeapi/errors/invalid_request_error"
 
 module Badgeapi
+  @api_base = 'https://badgeapi.lancaster.ac.uk/v1'
 
-	@api_base = 'https://badgeapi.lancaster.ac.uk/v1'
+  class << self
+    attr_accessor :api_key, :api_base, :ssl_ca_cert
+  end
 
-	class << self
-		attr_accessor :api_key, :api_base, :ssl_ca_cert
-	end
+  def self.api_url
+    @api_base
+  end
 
-	def self.api_url
-		@api_base
-	end
-
-	def self.api_key
-		@api_key
-	end
-
-	def self.ssl_ca_cert
-		@ssl_ca_cert
-	end
+  def self.api_key
+    @api_key
+  end
 
+  def self.ssl_ca_cert
+    @ssl_ca_cert
+  end
 end