corespring 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a0283546f49a445b6db5c3d2b1662da4dd3868d
-  data.tar.gz: b0dce4578a79f1e86bf5d1f517b51c401d07ea44
+  metadata.gz: f998e7babda3ab2b518d928f87aafbbbc168270e
+  data.tar.gz: 1657d703cfb70443dd00ee42a0b884a2272407ec
 SHA512:
-  metadata.gz: ae0f56518c3366054b31d4adc8eb2a937b103cadc500f8be10cecbcaa8942c940d2c2b4f5b9df131b87593fc1a13ba114ac11a1df2def7fcf851786fcb9b7946
-  data.tar.gz: c3f39d76ada1c1f6e068b55e627433a87e637822d393db9c5f883b111f2096a274293a6717c670ca19d7ab6ff826bd1c8919b0aa51570c614b3330ad913f0c53
+  metadata.gz: 3b8323bcf25626b8fce99490d2927432d4a60a5dbcb7174ebf6e77ff9615110caebf663e8324ea1862d7b087fb051b528da573fa8495ebb0dc53bfe87a466646
+  data.tar.gz: 86a2e6fb661e460d8eb1427885f34246a29be49de0f235241e82d5699e5cb260501516f8e6664b4de80c34873628ca6508dcf3fe0c12a98f2fe7d55050b00bce

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.0.0-p598

data/.travis.yml

@@ -1,2 +1,2 @@
 language: ruby
-script: rspec spec
+script: "bundle exec rspec spec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    corespring (0.0.1)
+    corespring (0.0.2)
       builder (>= 2.1.2)
       httparty (>= 0.8)
 
@@ -29,7 +29,6 @@ GEM
     rspec-mocks (2.99.3)
     safe_yaml (1.0.4)
     webmock (1.6.4)
-      addressable (~> 2.2, > 2.2.5)
       addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
 

data/README.rdoc

@@ -1,12 +1,12 @@
 == corespring-ruby
 
-Build Status: {<img src="https://travis-ci.org/corespring/corespring-ruby.svg" alt="Travis CI">}[https://travis-ci.org/corespring/corespring-ruby]
+{<img src="https://travis-ci.org/corespring/corespring-ruby.svg" alt="Travis CI">}[https://travis-ci.org/corespring/corespring-ruby]
 
 === Installation
 
 You can include the +corespring-ruby+ gem directly in your +Gemfile+:
 
-   gem 'corespring-ruby'
+   gem 'corespring', require: 'corespring-ruby'
 
 See the 'Examples' section about specific API usage.
 
@@ -14,7 +14,7 @@ See the 'Examples' section about specific API usage.
 
 A command line interface is availably if you install the Gem manually:
 
-   $ gem install corespring-ruby
+   $ gem install corespring
 
 In conjunction with this, a +~/.corespring+ file can be used to store your credentials:
 
@@ -54,4 +54,4 @@ Create a new +CoreSpring::APIClient+ object with your +client_id+ and +secret+:
 
 === LICENSE
 
-See the {LICENSE.txt}[link:LICENSE.txt] file for more information.
+See the {LICENSE.txt}[link:LICENSE.txt] file for more information.

data/lib/corespring-ruby.rb

@@ -1,7 +1,18 @@
 require 'httparty'
+require 'corespring/api_model'
+require 'corespring/primary_subject'
+require 'corespring/prior_use'
+require 'corespring/component'
+require 'corespring/score'
+require 'corespring/standard'
+require 'corespring/item'
+require 'corespring/item_session'
 require 'corespring/api_client'
+require 'corespring/player_options'
+require 'corespring/player_token'
+
 
 module CoreSpring
   include HTTParty
   self.base_uri 'https://platform.corespring.org'
-end
+end

data/lib/corespring/api_client.rb

@@ -1,46 +1,61 @@
 module CoreSpring
-  class APIClient
+  class APIError < StandardError; end
 
+  class APIClient
     def initialize(client_id, client_secret)
       @client_id = client_id
       @client_secret = client_secret
     end
 
-    def get_token
-      if @token.nil?
-        result = CoreSpring.post('/auth/access_token', body: {
-          client_id: @client_id,
-          client_secret: @client_secret
-        })
-        if result.code == 200
-          @token = JSON.parse(result.body)['access_token']
+
+    def get_item(item_id)
+      api_response(CoreSpring.get(api_url("/items/#{item_id}")), Item)
+    end
+
+    def get_item_session(session_id)
+      api_response(CoreSpring.get(api_url("/sessions/#{session_id}")), ItemSession)
+    end
+    
+    def create_item_session(item_id)
+      api_response(CoreSpring.post(api_url("/items/#{item_id}/sessions")), ItemSession)
+    end
+
+    def reopen_item_session(session_id)
+      api_response(CoreSpring.put("/api/v2/sessions/#{session_id}/reopen?access_token=#{access_token}"))
+    end
+
+    def complete_item_session(session_id)
+      api_response(CoreSpring.put("/api/v2/sessions/#{session_id}/complete?access_token=#{access_token}"))
+    end
+
+    def get_score(session_id)
+      api_response(CoreSpring.get(api_url("/sessions/#{session_id}/score.json")), Score)
+    end
+
+
+    private
+
+      def api_url(subset)
+        "/api/v2#{subset}?access_token=#{access_token}"
+      end
+      
+      def api_response(response, model=nil)
+        json = JSON.parse(response.body)
+        raise(APIError, json['message'] || json['error']) if response.code != 200
+
+        if model
+          model.new(json)
         else
-          throw :invalid_credentials
+          json
         end
       end
-      @token
-    end
 
-    def encrypt(options)
-      def digest_key(raw_key)
-        digest = Digest::MD5.new
-        digest.update(raw_key)
-        digest.digest
+      def get_access_token
+        api_response(CoreSpring.post('/auth/access_token', body: {client_id: @client_id, client_secret: @client_secret}))['access_token']
       end
 
-      aes = OpenSSL::Cipher::Cipher.new("AES-128-CBC")
-      iv = aes.random_iv
-      iv_hexed = iv.unpack('H*')[0]
-      key = digest_key(@client_secret)
-      aes.encrypt
-      aes.key = key
-      aes.iv = iv
-      cipher = aes.update(JSON.dump(options))
-      cipher << aes.final
-
-      encrypted_hexed = cipher.unpack('H*')[0]
-      "#{encrypted_hexed}--#{iv_hexed}"
-    end
-
+      def access_token
+        @access_token ||= get_access_token
+      end
   end
-end
+end

data/lib/corespring/api_model.rb

@@ -0,0 +1,14 @@
+module CoreSpring
+  class APIModel
+    def initialize(attrs={})
+      (attrs || {}).each do |key, value|
+       self.send("#{underscore(key)}=", value) 
+      end
+    end
+
+    private
+      def underscore(string)
+        string.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase.to_sym
+      end
+  end
+end

data/lib/corespring/component.rb

@@ -0,0 +1,5 @@
+module CoreSpring
+  class Component < APIModel
+    attr_accessor :answers, :stash, :weight, :score, :weighted_score
+  end
+end

data/lib/corespring/item.rb

@@ -0,0 +1,14 @@
+module CoreSpring
+  class Item < APIModel
+    attr_accessor :id, :author, :title, :primary_subject, :related_subject, :copyright_owner, :credentials, :grade_level, 
+                  :item_type, :standards, :key_skills, :blooms_taxonomy, :prior_use
+
+    def initialize(attrs={})
+      self.standards = (attrs.delete('standards') || []).map {|standard| Standard.new(standard)}
+      self.primary_subject = PrimarySubject.new(attrs.delete('primarySubject') || {})
+      self.prior_use = PriorUse.new(attrs.delete('priorUse') || {})
+
+      super
+    end
+  end
+end

data/lib/corespring/item_session.rb

@@ -0,0 +1,19 @@
+module CoreSpring
+  class ItemSession < APIModel
+    attr_accessor :id, :item_id, :completed, :components
+
+    def initialize(attrs={})
+      self.components = {}
+      (attrs.delete('components') || {}).each do |key, value|
+        self.components[underscore(key)] = Component.new(value)
+      end
+
+      super
+    end
+
+
+    def as_json
+      JSON.generate({completed: self.completed})
+    end
+  end
+end

data/lib/corespring/player_options.rb

@@ -0,0 +1,21 @@
+module CoreSpring
+  class PlayerOptions < Struct.new(:item_id, :session_id, :expires, :mode, :secure)
+    DEFAULTS = {
+      mode: 'view',
+      expires: 0,
+      secure: false,
+      session_id: '*',
+      item_id: nil,
+    }
+
+    def initialize(options={})
+      super
+      DEFAULTS.each {|k, v| self[k] = options[k] || v}
+    end
+
+    def player_json
+      self.item_id = '*' if !item_id && session_id == '*'
+      JSON.dump({mode: mode, itemId: item_id, sessionId: session_id, expires: expires, secure: secure}.reject {|k, v| v.nil?})
+    end
+  end
+end

data/lib/corespring/player_token.rb

@@ -0,0 +1,27 @@
+module CoreSpring
+  class PlayerToken < APIClient
+    def encrypt(player_options=PlayerOptions.new)
+      aes = OpenSSL::Cipher::Cipher.new("AES-128-CBC")
+      iv = aes.random_iv
+      iv_hexed = iv.unpack('H*')[0]
+      key = digest_key(@client_secret)
+      aes.encrypt
+      aes.key = key
+      aes.iv = iv
+      cipher = aes.update(player_options.player_json)
+      cipher << aes.final
+
+      encrypted_hexed = cipher.unpack('H*')[0]
+      "#{encrypted_hexed}--#{iv_hexed}"
+    end
+
+
+    private
+
+      def digest_key(raw_key)
+        digest = Digest::MD5.new
+        digest.update(raw_key)
+        digest.digest
+      end
+  end
+end

data/lib/corespring/primary_subject.rb

@@ -0,0 +1,5 @@
+module CoreSpring
+  class PrimarySubject < APIModel
+    attr_accessor :id, :subject, :category
+  end
+end

data/lib/corespring/prior_use.rb

@@ -0,0 +1,11 @@
+module CoreSpring
+  class PriorUse < APIModel
+    attr_accessor :contributor_name, :credentials, :grade_level, :source_url, :reviews_passed, :use, 
+                  :prior_use_other, :p_value, :primary_subject 
+
+    def initialize(attrs={})
+      self.primary_subject = PrimarySubject.new(attrs.delete('primarySubject'))
+      super
+    end
+  end
+end

data/lib/corespring/score.rb

@@ -0,0 +1,15 @@
+module CoreSpring
+  class Score < APIModel
+    attr_accessor :max_points, :points, :percentage, :components
+
+    def initialize(attrs={})
+      # TODO this logic is duplicated in item_session
+      self.components = {}
+      (attrs.delete('components') || {}).each do |key, value|
+        self.components[underscore(key)] = Component.new(value)
+      end
+
+      super(attrs['summary'])
+    end
+  end
+end

data/lib/corespring/standard.rb

@@ -0,0 +1,6 @@
+module CoreSpring
+  class Standard < APIModel
+    attr_accessor :id, :dot_notation, :subject, :category, :sub_category, :standard, :grades
+  end
+end
+

data/lib/corespring/version.rb

@@ -1,3 +1,3 @@
 module CoreSpring
-  VERSION = "0.0.1"
-end
+  VERSION = "0.0.4"
+end

data/spec/corespring/api_client_spec.rb

@@ -1,49 +1,92 @@
 require 'spec_helper'
 
 describe 'CoreSpring::APIClient' do
-
   let(:client_id) { SecureRandom.hex(13) }
   let(:client_secret) { SecureRandom.hex(13) }
   let(:client) { CoreSpring::APIClient.new(client_id, client_secret) }
 
-  describe 'get_token' do
+  let(:item_id) { SecureRandom.hex(13) }
+  let(:collection_id) { SecureRandom.hex(13) }
+  let(:session_id) { SecureRandom.hex(13) }
+  let(:access_token) { SecureRandom.hex(13) }
+
+
+  before(:each) do
+    stub_request(:post, "https://platform.corespring.org/auth/access_token").
+      with(:body => "client_id=#{client_id}&client_secret=#{client_secret}").
+      to_return(:status => 200, :body => "{\"access_token\": \"#{access_token}\"}", :headers => {})
+  end
+
+ 
+
+  describe "#get_item" do
+    before do
+      stub_request(:get, "https://platform.corespring.org/api/v2/items/#{item_id}?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
+    end
+
+    subject { client.get_item(item_id) }
+    
+    it { is_expected.to be_a(CoreSpring::Item) }
+  end
+
+
+  describe "#get_item_session" do
+    before do
+      stub_request(:get, "https://platform.corespring.org/api/v2/sessions/#{session_id}?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
+    end
 
-    describe 'with valid client_id and client_secret' do
-      let(:token) { SecureRandom.hex(13) }
-      subject { client.get_token }
+    subject { client.get_item_session(session_id) }
 
-      before {
-        stub_request(:post, "https://platform.corespring.org/auth/access_token")
-          .with(:body => "client_id=#{client_id}&client_secret=#{client_secret}")
-          .to_return(:status => 200, body: ({ access_token: token }.to_json))
-      }
+    it { is_expected.to be_a(CoreSpring::ItemSession) }
+  end
 
-      it { should == token }
 
+  describe "#create_item_session" do
+    before do
+      stub_request(:post, "https://platform.corespring.org/api/v2/items/#{item_id}/sessions?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
     end
 
-    describe 'with invalid client_id and client_secret' do
-      subject { client.get_token }
-      before {
-        stub_request(:post, "https://staging.corespring.org/auth/access_token")
-          .with(:body => "client_id=#{client_id}&client_secret=#{client_secret}")
-          .to_return(:status => 403, body: ({"code" => 100, "message" => "Invalid credentials", "moreInfo" => ""}.to_json))
-      }
+    subject { client.create_item_session(item_id) }
+
+    it { is_expected.to be_a(CoreSpring::ItemSession) }
+  end
 
-      it 'raises an error' do
-        expect { subject }.to raise_error
-      end
 
+  describe "#reopen_item_session" do
+    before do
+      stub_request(:put, "https://platform.corespring.org/api/v2/sessions/#{session_id}/reopen?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
     end
 
+    subject { client.reopen_item_session(session_id) }
+
+    it { is_expected.not_to be_nil }
   end
 
-  describe 'encrypt' do
-    let(:options) { {} }
-    subject { client.encrypt(options) }
 
-    it { should be_a(String) }
+  describe "#complete_item_session" do
+    before do
+      stub_request(:put, "https://platform.corespring.org/api/v2/sessions/#{session_id}/complete?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
+    end
 
+    subject { client.complete_item_session(session_id) }
+
+    it { is_expected.not_to be_nil }
   end
 
-end
+
+  describe "#get_score" do
+    before do
+      stub_request(:get, "https://platform.corespring.org/api/v2/sessions/#{session_id}/score.json?access_token=#{access_token}").
+         to_return(:status => 200, :body => "{}", :headers => {})
+    end
+    
+    subject { client.get_score(session_id) }
+
+    it { is_expected.to be_a(CoreSpring::Score) }
+  end
+end

data/spec/corespring/api_model_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'CoreSpring::APIModel' do
+  class FooModel < CoreSpring::APIModel
+    attr_accessor :id, :not_camel_case
+  end
+
+  describe "#initialize" do
+    subject { FooModel.new(attrs) }
+
+    context "with correct attributes" do
+      let(:attrs) { {id: :abc123} }
+      specify { expect(subject.id).to eq(:abc123) }
+    end
+
+    context "with camelCase attributes" do
+      let(:attrs) { {notCamelCase: :value} }
+      specify { expect(subject.not_camel_case).to eq(:value) }
+    end
+
+    context "with incorrect attributes" do
+      let(:attrs) { {foo: :bar} }
+      specify { expect { subject }.to raise_error }
+    end
+  end
+end

data/spec/corespring/item_session_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "CoreSpring::ItemSession" do
+  describe "#initialize" do
+    let(:attrs) { {'id' => 'asdf', 'itemId' => 'qwer', 'components' => {'foo' => {'answers' => ['choiceB']}}} }
+
+    subject { CoreSpring::ItemSession.new(attrs) }
+    
+    specify { expect(subject.id).to eq('asdf') }
+    specify { expect(subject.components).to include(:foo) }
+    specify { expect(subject.components[:foo]).to be_a(CoreSpring::Component) }
+  end
+end

data/spec/corespring/item_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "CoreSpring::Item" do
+  describe "#initialize" do
+    let(:attrs) do
+      {
+        'primarySubject' => {'id' => 'asdf'}, 
+        'standards' => [{'id' => 'asdf'}], 
+        'priorUse' => {'contributorName' => 'Patrick', 'primarySubject' => {'id' => 'asdf'}}
+      }
+    end
+
+    subject { CoreSpring::Item.new(attrs)}
+
+    specify { subject.standards.each {|s| expect(s).to be_a(CoreSpring::Standard)} }
+    specify { expect(subject.primary_subject).to be_a(CoreSpring::PrimarySubject) }
+    specify { expect(subject.prior_use).to be_a(CoreSpring::PriorUse) }
+  end
+end

data/spec/corespring/player_options_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "CoreSpring::PlayerOptions" do
+  let(:options) { {} }
+  let(:player_options) { CoreSpring::PlayerOptions.new(options) }
+
+
+  describe "defaults" do
+    specify { expect(player_options[:secure]).to be_falsey }
+    specify { expect(player_options[:expires]).to eq(0) }
+    specify { expect(player_options[:mode]).to eq('view') }
+    specify { expect(player_options[:item_id]).to be_nil }
+    specify { expect(player_options[:session_id]).to eq('*') }
+  end
+
+
+  describe "#player_json" do
+    subject { player_options.player_json }
+
+    it { is_expected.to match(/^\{.+\}$/) }
+    it { is_expected.to include('"sessionId":') }
+    it { is_expected.to include('"itemId":') }
+
+
+    context "with a session_id" do
+      let(:options) { {session_id: "ADF123"} }
+
+      it { is_expected.to include('"sessionId":') }
+      it { is_expected.not_to include('"itemId":') }
+    end
+  end
+end

data/spec/corespring/player_token_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'CoreSpring::PlayerToken' do
+  let(:client_id) { SecureRandom.hex(13) }
+  let(:client_secret) { SecureRandom.hex(13) }
+  let(:client) { CoreSpring::PlayerToken.new(client_id, client_secret) }
+
+
+  describe '#encrypt' do
+    let(:options) { CoreSpring::PlayerOptions.new }
+    subject { client.encrypt(options) }
+
+    it { should be_a(String) }
+  end
+end

data/spec/corespring/prior_use_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "CoreSpring::PriorUse" do
+  describe "#initialize" do
+    let(:attrs) { {'contributorName' => "Patrick", 'primarySubject' => {'id' => "asdf"}} }
+
+    subject { CoreSpring::PriorUse.new(attrs) }
+
+    specify { expect(subject.contributor_name).to eq("Patrick") }
+    specify { expect(subject.primary_subject).to be_a(CoreSpring::PrimarySubject) }
+  end
+end

data/spec/spec_helper.rb

@@ -9,7 +9,8 @@ RSpec.configure do |config|
   config.before(:suite) do
     WebMock.disable_net_connect!
   end
+
   config.after(:suite) do
     WebMock.allow_net_connect!
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corespring
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Ben Burton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -102,8 +102,24 @@ files:
 - corespring.gemspec
 - lib/corespring-ruby.rb
 - lib/corespring/api_client.rb
+- lib/corespring/api_model.rb
+- lib/corespring/component.rb
+- lib/corespring/item.rb
+- lib/corespring/item_session.rb
+- lib/corespring/player_options.rb
+- lib/corespring/player_token.rb
+- lib/corespring/primary_subject.rb
+- lib/corespring/prior_use.rb
+- lib/corespring/score.rb
+- lib/corespring/standard.rb
 - lib/corespring/version.rb
 - spec/corespring/api_client_spec.rb
+- spec/corespring/api_model_spec.rb
+- spec/corespring/item_session_spec.rb
+- spec/corespring/item_spec.rb
+- spec/corespring/player_options_spec.rb
+- spec/corespring/player_token_spec.rb
+- spec/corespring/prior_use_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/corespring/corespring-ruby
 licenses: []
@@ -124,10 +140,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: corespring
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: CoreSpring API Client
 test_files:
 - spec/corespring/api_client_spec.rb
+- spec/corespring/api_model_spec.rb
+- spec/corespring/item_session_spec.rb
+- spec/corespring/item_spec.rb
+- spec/corespring/player_options_spec.rb
+- spec/corespring/player_token_spec.rb
+- spec/corespring/prior_use_spec.rb
 - spec/spec_helper.rb