badgeapi 0.3.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff525cd89255e0ca871bf73be2df0a4bdb51bdb4
+  data.tar.gz: d12d2686a38ba0c9b0bb5a5f86e46b2927567857
+SHA512:
+  metadata.gz: 7aaa17617b920cf4b10812bd8c7a5996acdab7cca2ae684868e08af42c2e0211975e7abfc7258441ec2f143f2e895711598c5d1efdb19366b42f5d5aba0a33e7
+  data.tar.gz: 37accdf894db35092d71d13e33caf76b2321fc4e94a7ea39dc73013a7827653daf0d663edc39322ea5c4161ee8fed7d08cfa8696109b01c9f1682733720b3d7a

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.ruby-version
+.yardoc
+.rake_tasks~
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in badgeapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tom Skarbek Wazynski
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# .
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '.'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install .
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/./fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+desc "Open an pry/irb session preloaded with badgeapi"
+task :console do
+	irb = "pry"
+	# Check if pry installed
+	begin
+		gem "pry"
+	rescue Gem::LoadError
+		irb = "irb"
+	end
+	puts "Loading badgeapi gem with #{irb}"
+
+	exec "#{irb} -I lib -r badgeapi.rb"
+end

data/badgeapi.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'badgeapi/version'
+
+Gem::Specification.new do |spec|
+	spec.name 				= "badgeapi"
+	spec.version 			= Badgeapi::VERSION
+	spec.authors 			= ["Tom Skarbek Wazynski"]
+	spec.email 				= ["wazynski@gmail.com"]
+	spec.summary 			= %q{A basic API wrapper for Lancaster University's Badge API.}
+	spec.description 			= %q{Allows you to connect to Lancaster University's Badge API to manipulate badges, issue badges and display badges.}
+	spec.homepage			= "http://innovationhub.lancaster.ac.uk"
+	spec.license 			= "MIT"
+
+	spec.files 				= `git ls-files -z`.split("\x0")
+	spec.executables 		= spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files 		= spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths 		= ["lib"]
+
+	spec.add_development_dependency "minitest", "~> 5.5"
+	spec.add_development_dependency "minitest-focus", "~> 1.1"
+	spec.add_development_dependency "vcr", "~> 2.9"
+	spec.add_development_dependency "webmock", "~> 1.20"
+
+	# So it works with rails 4 and 3
+	spec.add_dependency "activesupport", "> 3.2"
+	spec.add_dependency "faraday", "~> 0.9"
+	spec.add_dependency "json", "~> 1.8"
+
+	spec.add_development_dependency "bundler", "~> 1.7"
+	spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/badgeapi/badge.rb

@@ -0,0 +1,29 @@
+#lib/badgeapi/badge.rb
+module Badgeapi
+	class Badge < BadgeapiObject
+
+		attr_reader :id, :created_at, :updated_at, :collection, :points, :required_badges, :image, :object
+		attr_accessor :name, :description, :requirements, :requirements, :hint, :recipient_id, :collection_id, :issuer_id, :issued_at, :level, :auto_issue, :status
+
+
+		class << self
+
+			def issue id, params = {}
+				request "post", "#{Badgeapi.api_url}/#{collection_path}/#{id}/issue", params
+			end
+
+			def revoke id, params = {}
+				request "post", "#{Badgeapi.api_url}/#{collection_path}/#{id}/revoke", params
+			end
+
+			def add_badge_requirement id, required_id
+				request "post", "#{Badgeapi.api_url}/#{collection_path}/#{id}/requires", {required_badge: {id: required_id}}
+			end
+
+			def remove_badge_requirement id, required_id
+				request "delete", "#{Badgeapi.api_url}/#{collection_path}/#{id}/requires", {required_badge: {id: required_id}}
+			end
+
+		end
+	end
+end

data/lib/badgeapi/badgeapi_object.rb

@@ -0,0 +1,149 @@
+#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
+end

data/lib/badgeapi/collection.rb

@@ -0,0 +1,10 @@
+#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

data/lib/badgeapi/errors/api_error.rb

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

data/lib/badgeapi/errors/badgeapi_error.rb

@@ -0,0 +1,18 @@
+module Badgeapi
+	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 to_s
+			status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+			"#{status_string}#{@message}"
+		end
+	end
+end

data/lib/badgeapi/errors/invalid_request_error.rb

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

data/lib/badgeapi/recipient.rb

@@ -0,0 +1,18 @@
+#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
+
+		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

@@ -0,0 +1,3 @@
+module Badgeapi
+  VERSION = "0.3.8"
+end

data/lib/badgeapi.rb

@@ -0,0 +1,36 @@
+require 'active_support/all'
+require 'faraday'
+require 'json'
+
+require_relative "badgeapi/badgeapi_object"
+require_relative "badgeapi/version"
+require_relative "badgeapi/badge"
+require_relative "badgeapi/collection"
+require_relative "badgeapi/recipient"
+
+# Errors
+require_relative "badgeapi/errors/badgeapi_error"
+require_relative "badgeapi/errors/api_error"
+require_relative "badgeapi/errors/invalid_request_error"
+
+module Badgeapi
+
+	@api_base = 'https://badgeapi.lancaster.ac.uk/v1'
+
+	class << self
+		attr_accessor :api_key, :api_base, :ssl_ca_cert
+	end
+
+	def self.api_url
+		@api_base
+	end
+
+	def self.api_key
+		@api_key
+	end
+
+	def self.ssl_ca_cert
+		@ssl_ca_cert
+	end
+
+end