badgeapi 0.3.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0fb85428425957c7619fe7ee0a63e0173d862e9
-  data.tar.gz: bc580ac603059f82dfe56d03da531b6dcea3ca15
+  metadata.gz: 77938855273965df1555a82b886eeb17f8333655
+  data.tar.gz: 824f4b0f3d188571b45ea02da501296f1ba2eb0a
 SHA512:
-  metadata.gz: b9b3a48f43ad53375124912ffdd1176d8dfd52c343d9c3821268fcbecb696a24c40d816ef42e4cc2c3fb6bdc0ef98053cae9628c958f30e349252604b356f806
-  data.tar.gz: 775493e635ccbad1d2ecfa640a3965cabbe240340d4e20506e8d8a5e758641d4211c12539fe1f0b5a3e5ade35f274d833d0be93ceef3b944f495999dae24673f
+  metadata.gz: 9dfe48d531b39b9e3cf5413309845de41fcf1152ba41c036e8a9c4768b526753b6efce7e242418422e9ceb1e6cd3843d8f0bd1b98584608528b8e173b08b5c78
+  data.tar.gz: 9f5ad569beb69dd850e1302e283843cc93697a7d62dc66f94816176e61c1cd3a6788c97c58019c6217e4f9a82d760b6d4721449136b837e01660d4c0571bd605

data/.gitignore

@@ -11,4 +11,5 @@ coverage/*
 doc/*
 log/*
 pkg/*
-.idea/*
+.idea/*
+.editorconfig

data/.rubocop.yml

@@ -0,0 +1,147 @@
+AllCops:
+  RunRailsCops: true
+  Include:
+    - Rakefile
+    - config.ru
+  Exclude:
+    - config/initializers/simple_form_bootstrap.rb
+    - config/initializers/simple_form.rb
+    - db/schema.rb
+    - test/**/*
+    - db/**/*
+    - bin/**/*
+
+# Commonly used screens these days easily fit more than 80 characters.
+Metrics/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+# Style/SpaceAroundEqualsInParameterDefault:
+#   EnforcedStyle: no_space
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# Enforcing double quotes reduces the times where you need to change them
+# when introducing an interpolation. Use single quotes only if their semantics
+# are needed.
+Style/StringLiterals:
+  Enabled: false
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/DeprecatedHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+Style/AndOr:
+  Enabled: false
+
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/HandleExceptions:
+  Enabled: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+# Style/SpaceInsideHashLiteralBraces:
+#   EnforcedStyle: no_space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Style/OpMethod:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

data/README.md

@@ -1,13 +1,21 @@
-# .
+# Lancaster University Badge API Gem
 
-TODO: Write a gem description
+The <strong>badgeapi</strong> gem provides Ruby bindings for the [Lancaster University Badge API](http://innovationhub.lancaster.ac.uk/projects/gamification) platform. It allows for quicker and easier access, insertion and consumption of data from the API.
+
+## Documentation
+
+You can find API documentation and examples of how to use this gem at the [Badge API Docs](http://badgeapi.lancaster.ac.uk).
+
+## Requirements
+
+Your application will need to make request via SSL/HTTPS. If you are developing locally the [rechampoulier/tunnelss](https://github.com/rchampourlier/tunnelss) can be used but you will need to follow the Certificate Authority Fix below.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem '.'
+gem badgeapi
 ```
 
 And then execute:
@@ -16,16 +24,40 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install .
+    $ gem install badgeapi
+
+You will need to provide your api key to the gem:
+
+```ruby
+Badgeapi.api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+```    
+
+### Certificate Authority Fix
+
+The gem relies on Faraday to make the http requests to the API. If you get get any Farday SSL errors, this is because Farday cannot find your CA Certificate. More info at [Faraday: Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates).
+
+Once you know the location of your CA certificates path your can provide this to the gem via:
+
+```ruby
+Badgeapi.ssl_ca_cert='/usr/lib/ssl/certs'
+```  
+
+If using [rechampoulier/tunnelss](https://github.com/rchampourlier/tunnelss) for local development.
+
+```ruby
+Badgeapi.ssl_ca_cert='/Users/your_user/.tunnelss/ca/cert.pem'
+```  
+
+## Development
+
+Use the gems console:
+
+    $ rake console
 
-## Usage
+Run all tests:
 
-TODO: Write usage instructions here
+    $ bundle exec rake
 
-## Contributing
+Run a single test suite:
 
-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
+    $ruby test/badge/badge_test.rb

data/Rakefile

@@ -1,15 +1,28 @@
+# Console
 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
+  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
+
+# Tests
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb'] + FileList['test/*/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/badgeapi.gemspec

@@ -4,30 +4,31 @@ $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.name = "badgeapi"
+  spec.version 		 = Badgeapi::VERSION
+  spec.authors 		 = ["Tom Skarbek Wazynski"]
+  spec.email = ["wazynski@gmail.com"]
+  spec.summary = "A basic API wrapper for Lancaster University's Badge API"
+  spec.description = "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.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"
+  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"
+  # 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"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/badgeapi/badge.rb

@@ -1,29 +1,26 @@
-#lib/badgeapi/badge.rb
+# lib/badgeapi/badge.rb
 module Badgeapi
-	class Badge < BadgeapiObject
-
-		attr_reader :id, :created_at, :updated_at, :collection, :points, :required_badges, :image, :object, :recipients
-		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
+  class Badge < BadgeapiObject
+    attr_reader :id, :created_at, :updated_at, :collection, :points, :required_badges, :image, :object, :recipients
+    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