open_badges 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/bin

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eric Allam
+
+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,83 @@
+# OpenBadges
+
+Provides some objects to make it easy to work with the OpenBadges [issuer API](https://github.com/mozilla/openbadges/wiki/Issuer-API). Right
+now this only includes the ability to create the [Assertion JSON](https://github.com/mozilla/openbadges/wiki/Assertions) necessary when responding
+to a assertion request from OpenBadges.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_badges'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_badges
+
+## Usage
+
+Using this in a Rails app is really simple.  Let's say you have a `BadgesController`
+with a `assertion` action that will serve up the assertion JSON.  Here is how you would use it:
+
+```ruby
+class BadgesController < ApplicationController
+  def assertion
+    assertion = OpenBadges::Assertion.new
+    # You'd probably fill in these values from some `badges` table and
+    # user information
+    assertion.email = "<email>"
+    assertion.issued_on = Time.now
+    assertion.name = "Completed Level 1 of Something"
+    assertion.description = "Completed Level 1 of Something"
+    assertion.badge_url = "http://www.codeschool.com/badges/1"
+    assertion.criteria_url = "http://www.codeschool.com/badges/1"
+
+    render json: assertion
+  end
+end
+```
+
+And then setup a couple of pieces of information about you, the issuer, in the respective environment:
+
+```ruby
+# in config/environments/production.rb
+  config.after_initialize do
+    OpenBadges.issuer_url = "http://www.codeschool.com"
+    OpenBadges.issuer_name = "Code School"
+  end
+```
+
+This would create JSON that looked like this:
+
+```javascript
+{
+  :recipient=>"sha256$56ad781803f326ddab2f5eaa270964d40d43a11abd193fdb121334f1e653263a", 
+  :salt=>"c1be0242548c455c654e720ae304e5b6", 
+  :issued_on=>"2012-08-26", 
+  :badge=>{
+    :version=>"0.5.0", 
+    :name=>"Completed Level 1 of Something", 
+    :image=>"http://www.codeschool.com/badges/1", 
+    :description=>"Completed Level 1 of Something", 
+    :criteria=>"http://www.codeschool.com/badges/1/criteria", 
+    :issuer=>{
+      :origin=>"http://www.codeschool.com", 
+      :name=>"Code School", 
+      :org=>nil, 
+      :contact=>nil
+    }
+  }
+}
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/open_badges/assertion.rb

@@ -0,0 +1,44 @@
+require 'digest'
+require 'securerandom'
+
+module OpenBadges
+  class Assertion
+    attr_accessor :email, :issued_on, :name, :description,
+                    :badge_url, :criteria_url
+
+    def as_json options={}
+      {
+        recipient: recipient,
+        salt: salt,
+        issued_on: issued_on,
+        badge: {
+          version: OpenBadges.version,
+          name: self.name,
+          image: self.badge_url,
+          description: self.description,
+          criteria: criteria_url,
+          issuer: {
+            origin: OpenBadges.issuer_url,
+            name: OpenBadges.issuer_name,
+            org: OpenBadges.issuer_org,
+            contact: OpenBadges.issuer_contact
+          }
+        }
+      }
+    end
+
+    private
+
+    def recipient
+      "sha256$#{Digest::SHA256.hexdigest(self.email + salt)}"
+    end
+
+    def salt
+      @salt ||= SecureRandom.hex
+    end
+
+    def issued_on
+      @issued_on.strftime("%Y-%m-%d")
+    end
+  end
+end

data/lib/open_badges/version.rb

@@ -0,0 +1,3 @@
+module OpenBadges
+  VERSION = "0.0.1"
+end

data/lib/open_badges.rb

@@ -0,0 +1,13 @@
+require "open_badges/version"
+require "open_badges/assertion"
+require "active_support/core_ext"
+
+module OpenBadges
+  mattr_accessor :issuer_url
+  mattr_accessor :issuer_name
+  mattr_accessor :issuer_org
+  mattr_accessor :issuer_contact
+  mattr_accessor :version
+  self.version = "0.5.0"
+  mattr_accessor :salt
+end

data/open_badges.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_badges/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "open_badges"
+  gem.version       = OpenBadges::VERSION
+  gem.authors       = ["Eric Allam"]
+  gem.email         = ["rubymaverick@gmail.com"]
+  gem.description   = %q{Work with OpenBadges Issuer API}
+  gem.summary       = %q{Work with OpenBadges Issuer API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport", "~> 3.2.0"
+
+  gem.add_development_dependency "rspec", "2.11.0"
+  gem.add_development_dependency "timecop", "0.4.5"
+end

data/spec/assertion_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../lib/open_badges'
+require 'timecop'
+require 'digest'
+
+describe OpenBadges::Assertion do
+  # Timecop freezes time
+  before(:all) { Timecop.freeze(Time.local(2012, 8, 26, 12, 0, 0)) }
+  after(:all) { Timecop.return }
+
+  def digest message
+    Digest::SHA256.hexdigest(message)
+  end
+
+  let(:assertion) { described_class.new }
+
+  context "#as_json" do
+    subject { assertion.as_json }
+
+    before do
+      OpenBadges.issuer_url = "http://www.codeschool.com"
+      OpenBadges.issuer_name = "Code School"
+
+      assertion.email = "rubymaverick@gmail.com"
+      assertion.issued_on = Time.now
+      assertion.name = "Completed Level 1 of Ruby Bits"
+      assertion.description = "Completed Level 1 of Ruby Bits"
+      assertion.badge_url = "http://www.codeschool.com/badges/1"
+      assertion.criteria_url = "http://www.codeschool.com/badges/1/criteria"
+    end
+
+    it "should produce valid json" do
+      subject[:recipient].split("$").first.should == "sha256"
+      subject[:recipient].split("$").last.should == digest(assertion.email + subject[:salt])
+      subject[:issued_on].should == "2012-08-26"
+
+      badge = subject[:badge]
+      badge[:version].should == OpenBadges.version
+      badge[:name].should == assertion.name
+      badge[:description].should == assertion.description
+      badge[:image].should == assertion.badge_url
+      badge[:criteria].should == assertion.criteria_url
+
+      issuer = badge[:issuer]
+      issuer[:origin].should == OpenBadges.issuer_url
+      issuer[:name].should == OpenBadges.issuer_name
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: open_badges
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Allam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+description: Work with OpenBadges Issuer API
+email:
+- rubymaverick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_badges.rb
+- lib/open_badges/assertion.rb
+- lib/open_badges/version.rb
+- open_badges.gemspec
+- spec/assertion_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Work with OpenBadges Issuer API
+test_files:
+- spec/assertion_spec.rb