meducation_sdk 1.5.7 → 1.6.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 59cdaa5f76cdde2eb332690eda73a06fc48f7679
-  data.tar.gz: 954e3a4ecf08267207ccea0751c0896d719bf8f6
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGJlOWVmZDZhOTE1NDRhY2M5ODcyYzgzYTE0ZDVkNWY1NDJkYTZiYw==
+  data.tar.gz: !binary |-
+    ZjI3NzAzODg0YzExMzA5ZTczZGMwYmY0ZTZkMzViMDM5NjYyYTdlZA==
 SHA512:
-  metadata.gz: 1e5e383e3455c0109d8399762c5dcf73deedbfa7e234a0e18913c2caeb702fe5c2a0a116a2e40116ebc022bf55a8c946f35436b4ca3b378f40a5d22cc6beca6b
-  data.tar.gz: 6e468ec9dfe67820d6857ead5038651b2985024d5e2d9969030dd53ce00169bce7a101f40ebfca5413ba6c4c3f7317d84cf11c6c4f0d396c2048844c88059fc3
+  metadata.gz: !binary |-
+    M2ZhNTUyMjZmMzU2NDMyYTZkYWMzZjQ3MzcwN2FkYWI3NGJkOTMwODI0N2I4
+    ZDliZWFmMGE2MzMxMzJiNjdkZTdhNWEzNjhkZjlhODNiZDVlYzMyMjAxZWNl
+    ZDUwODc2NzkwMGRhMzgwNjczMDNkMTBjODBiZTY1YTIyMjM2Mzg=
+  data.tar.gz: !binary |-
+    NzNhYjJhYTNjYTFjNTMyZWY0NTMxMGM3OTI0ZDVlMGZiN2RhNDM4NjJkNjA2
+    M2RiMGUwYWIzYzE5NGUyNTEyZjRkZWIxZmIyOTQwOWUxZTZiNDJiMGMyNWZl
+    NmUyYTVlNDFlNmU5Y2QzOTRmNjgwYmM3MWZiNDcxOGJhYWYwNDE=

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# 1.5.7 / 2014-03-4
+# 1.6.0 / 2014-03-07
+* [FEATURE] Add recommender
+* [FEATURE] Change routing to spi.meducation.net
+
+# 1.5.7 / 2014-03-04
 * [FEATURE] Add authors to to collection topics
 
 # 1.5.6 / 2014-02-27

data/lib/meducation_sdk.rb

@@ -5,62 +5,9 @@ require "meducation_sdk/version"
 require "meducation_sdk/configuration"
 require "meducation_sdk/mocker"
 
+require "meducation_sdk/helpers"
+require "meducation_sdk/services/recommender"
 require "meducation_sdk/resource"
-require "meducation_sdk/resources/badges/badge"
-
-RESOURCES = %w{
-  author
-  badges/answerer_badge
-  badges/befriender_badge
-  badges/citizen_badge
-  badges/commentator_badge
-  badges/community_member_badge
-  badges/contributor_badge
-  badges/eminent_author_badge
-  badges/enlightener_badge
-  badges/inquisitive_mind_badge
-  badges/photogenic_badge
-  badges/questioner_badge
-  badges/respected_author_badge
-  blog_post
-  blogger
-  board
-  board_follow
-  board_item
-  collection
-  collection_section
-  collection_topic
-  comment
-  community
-  community_membership
-  dashboard_item
-  ecommerce_subscription
-  external_resource
-  friendship
-  group
-  group_discussion
-  group_discussion_post
-  group_invite
-  group_membership
-  knowledge_bank_question
-  knowledge_bank_answer
-  media_file
-  mesh_heading
-  message
-  message_thread
-  message_thread_contributor
-  mnemonic
-  notification
-  partner
-  syllabus_item
-  user
-  user_email_data
-  user_settings
-  vote
-}
-RESOURCES.each do |resource|
-  require "meducation_sdk/resources/#{resource}"
-end
 
 module MeducationSDK
   def self.config

data/lib/meducation_sdk/configuration.rb

@@ -6,7 +6,10 @@ module MeducationSDK
 
   class Configuration
 
-    SETTINGS = [ :logger ]
+    SETTINGS = [ 
+      :logger, 
+      :recommender_host, :recommender_port 
+    ]
 
     attr_writer *SETTINGS
 
@@ -14,11 +17,14 @@ module MeducationSDK
       self.logger = Filum.logger
 
       Loquor.config do |config|
-        config.endpoint = "http://www.meducation.net/system"
+        config.endpoint = "http://spi.meducation.net"
         config.substitute_values[true]  = ":__true__"
         config.substitute_values[false] = ":__false__"
         config.retry_404s = true
       end
+
+      self.recommender_host = "recommender.meducation.net"
+      self.recommender_port = 4567
     end
 
     [:access_id, :secret_key, :endpoint, :cache].each do |setting|

data/lib/meducation_sdk/helpers.rb

@@ -0,0 +1,26 @@
+module MeducationSDK
+  module Helpers
+    SDK_TO_SPI_MAPPINGS = {}
+
+    def sdk_class_for(spi_type)
+      sdk_type_for(spi_type).constantize
+    end
+
+    def sdk_type_for(spi_type)
+      if SDK_TO_SPI_MAPPINGS.has_value?(spi_type)
+        SDK_TO_SPI_MAPPINGS.key(spi_type)
+      else
+        "MeducationSDK::#{spi_type.gsub("::", "")}"
+      end
+    end
+
+    def spi_type_for(sdk_type)
+      if SDK_TO_SPI_MAPPINGS.has_key?(sdk_type)
+        SDK_TO_SPI_MAPPINGS[sdk_type]
+      else
+        sdk_type.gsub("MeducationSDK::", "")
+      end
+    end
+  end
+end
+

data/lib/meducation_sdk/resource.rb

@@ -1,5 +1,11 @@
 module MeducationSDK
   class Resource < Loquor::Resource
+    include Helpers
+
+    def self.spi_type=(type)
+      Helpers::SDK_TO_SPI_MAPPINGS[self.name] = type
+    end
+
     def created_at
       DateTime.parse(@data[:created_at])
     end
@@ -7,14 +13,61 @@ module MeducationSDK
     def updated_at
       DateTime.parse(@data[:updated_at])
     end
-
-    def class_for(meducation_type)
-      case meducation_type
-      when "Item::Comment"
-        Comment
-      else
-        "MeducationSDK::#{meducation_type.gsub("::", "")}".constantize
-      end
-    end
   end
 end
+
+RESOURCES = %w{
+  author
+  badges/answerer_badge
+  badges/befriender_badge
+  badges/citizen_badge
+  badges/commentator_badge
+  badges/community_member_badge
+  badges/contributor_badge
+  badges/eminent_author_badge
+  badges/enlightener_badge
+  badges/inquisitive_mind_badge
+  badges/photogenic_badge
+  badges/questioner_badge
+  badges/respected_author_badge
+  blog_post
+  blogger
+  board
+  board_follow
+  board_item
+  collection
+  collection_section
+  collection_topic
+  comment
+  community
+  community_membership
+  dashboard_item
+  ecommerce_subscription
+  external_resource
+  friendship
+  group
+  group_discussion
+  group_discussion_post
+  group_invite
+  group_membership
+  knowledge_bank_question
+  knowledge_bank_answer
+  media_file
+  mesh_heading
+  message
+  message_thread
+  message_thread_contributor
+  mnemonic
+  notification
+  partner
+  syllabus_item
+  user
+  user_email_data
+  user_settings
+  vote
+}
+
+require "meducation_sdk/resources/badges/badge"
+RESOURCES.each do |resource|
+  require "meducation_sdk/resources/#{resource}"
+end

data/lib/meducation_sdk/resources/board.rb

@@ -3,7 +3,7 @@ module MeducationSDK
     self.path = "/boards"
 
     def owner
-      @owner ||= class_for(owner_type).find(owner_id)
+      @owner ||= sdk_class_for(owner_type).find(owner_id)
     end
 
     def created_by

data/lib/meducation_sdk/resources/board_item.rb

@@ -3,7 +3,7 @@ module MeducationSDK
     self.path = "/board_items"
 
     def item
-      @item ||= class_for(item_type).find(item_id)
+      @item ||= sdk_class_for(item_type).find(item_id)
     end
 
     def board

data/lib/meducation_sdk/resources/comment.rb

@@ -1,9 +1,10 @@
 module MeducationSDK
   class Comment < Resource
     self.path = "/comments"
+    self.spi_type = "Item::Comment"
 
     def item
-      @item ||= class_for(item_type).find(item_id)
+      @item ||= sdk_class_for(item_type).find(item_id)
     end
 
     def user

data/lib/meducation_sdk/resources/dashboard_item.rb

@@ -7,7 +7,7 @@ module MeducationSDK
     end
 
     def item
-      @item ||= class_for(item_type).find(item_id)
+      @item ||= sdk_class_for(item_type).find(item_id)
     end
   end
 

data/lib/meducation_sdk/resources/knowledge_bank_question.rb

@@ -1,6 +1,7 @@
 module MeducationSDK
   class KnowledgeBankQuestion < Resource
     self.path = "/knowledge_bank_questions"
+    self.spi_type = "KnowledgeBank::Question"
 
     def user
       @user = User.find(user_id)

data/lib/meducation_sdk/resources/notification.rb

@@ -3,7 +3,7 @@ module MeducationSDK
     self.path = "/notifications"
 
     def item
-      @item ||= class_for(item_type).find(item_id)
+      @item ||= sdk_class_for(item_type).find(item_id)
     end
 
     def user

data/lib/meducation_sdk/resources/vote.rb

@@ -1,9 +1,10 @@
 module MeducationSDK
   class Vote < Resource
     self.path = "/votes"
+    self.spi_type = "Item::Vote"
 
     def item
-      @item ||= class_for(item_type).find(item_id)
+      @item ||= sdk_class_for(item_type).find(item_id)
     end
 
     def user

data/lib/meducation_sdk/services/recommender.rb

@@ -0,0 +1,70 @@
+module MeducationSDK
+  class Recommender
+    include Helpers
+
+    def self.recommend(item, options = {})
+      new(item, options).recommend
+    end
+
+    attr_reader :item
+    def initialize(item, options = {})
+      @item = item
+      @options = options
+    end
+
+    def recommend
+      generate_recommendations
+    rescue => e
+      log_error("!!Recommender Error!!")
+      log_error(e.message)
+      log_error(e.backtrace)
+      #Item::Recommendation.where(item_type: @item.class.name).where(item_id: @item.id).includes(:recommendation).map(&:recommendation)
+      []
+    end
+
+    def generate_recommendations
+      groupings = {}
+      correct_order = recommender_results.map do |result|
+        groupings[result['type']] ||= []
+        groupings[result['type']] << result['id']
+        "#{result['type']}##{result['id']}"
+      end
+
+      output = groupings.map {|(type, ids)| sdk_class_for(type).where(id: ids) }.flatten
+      output.sort_by!{ |item| correct_order.index("#{item.class.name}##{item.id}") }
+      output
+    end
+
+    def recommender_results
+      @recommender_results ||= begin
+        results = JSON.parse(recommender_json)
+        if @options[:limit]
+          results[0..(@options[:limit] - 1)]
+        else
+          results
+        end
+      end
+    end
+
+    def recommender_json
+      path = "/#{spi_type_for(item.class.name)}/#{item.id}"
+      log "Calling #{config.recommender_host}:#{config.recommender_host}#{path}"
+      response = Net::HTTP.get_response(config.recommender_host, path, config.recommender_port)
+      body = response.body
+      log "Received #{body}"
+      body
+    end
+
+    def log(*args)
+      config.logger.info(*args)
+    end
+
+    def log_error(*args)
+      config.logger.error(*args)
+    end
+
+    def config
+      MeducationSDK.config
+    end
+  end
+end

data/lib/meducation_sdk/version.rb

@@ -1,3 +1,3 @@
 module MeducationSDK
-  VERSION = "1.5.7"
+  VERSION = "1.6.0"
 end

data/test/configuration_test.rb

@@ -22,10 +22,10 @@ module MeducationSDK
 
     def test_endpoint_is_set_correctly
       Configuration.new
-      assert_equal "http://www.meducation.net/system", Loquor.config.endpoint
+      assert_equal "http://spi.meducation.net", Loquor.config.endpoint
     end
 
-    def test_endpoint_is_set_correctly
+    def test_retry_404s_is_set_correctly
       Configuration.new
       assert_equal true, Loquor.config.retry_404s
     end

data/test/helpers_test.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+module MeducationSDK
+  class HelperTestClass
+    include Helpers
+  end
+
+  class HelpersTest < Minitest::Test
+    {
+      "Item::Comment" => "MeducationSDK::Comment",
+      "KnowledgeBank::Question" => "MeducationSDK::KnowledgeBankQuestion"
+    }.each do |spi_type, sdk_type|
+      define_method "test_sdk_type_for_#{spi_type.underscore.gsub("/", "_")}" do
+        assert_equal sdk_type, HelperTestClass.new.sdk_type_for(spi_type)
+      end
+      define_method "test_sdk_class_for_#{spi_type.underscore.gsub("/", "_")}" do
+        assert_equal sdk_type.constantize, HelperTestClass.new.sdk_class_for(spi_type)
+      end
+      define_method "test_spi_type_for_#{spi_type.underscore.gsub("/", "_")}" do
+        assert_equal spi_type, HelperTestClass.new.spi_type_for(sdk_type)
+      end
+    end
+  end
+end

data/test/resource_test.rb

@@ -17,15 +17,8 @@ module MeducationSDK
         end
       end
     end
-
-    {
-      "Item::Comment" => Comment,
-      "KnowledgeBank::Question" => KnowledgeBankQuestion
-    }.each do |meducation_type, sdk_class|
-      define_method "test_class_for_#{meducation_type.underscore.gsub("/", "_")}" do
-        r = Resource.new({})
-        assert_equal sdk_class, r.class_for(meducation_type)
-      end
+    define_method "test_helpers_included" do
+      assert Resource.new({}).respond_to?(:sdk_class_for)
     end
 
     def test_created_at_is_a_datetime

data/test/services/recommender_test.rb

@@ -0,0 +1,72 @@
+require_relative '../test_helper'
+
+module MeducationSDK
+  class RecommenderTest < Minitest::Test
+
+    def empty_response
+      mock(body: '[]')
+    end
+
+    def item
+      @item ||= MediaFile.new({id: 10})
+    end
+
+    def item2
+      @item2 ||= MediaFile.new({id: 56})
+    end
+
+    def test_should_call_new
+      Recommender.expects(:new).with(item, {}).returns(mock(recommend: nil))
+      Recommender.recommend(item)
+    end
+
+    def test_should_proxy_to_recommend
+      Recommender.any_instance.expects(:recommend)
+      Recommender.recommend(nil)
+    end
+
+    def test_should_call_the_recommender_service
+      Net::HTTP.expects(:get_response).with("recommender.meducation.net", "/MediaFile/#{item.id}", 4567).returns(empty_response)
+      Recommender.new(item).recommend
+    end
+
+    def test_should_call_parse_results_of_recommendation_service
+      json = [
+        {"type" => "MediaFile", "id" => item.id, "score" => 0.0097},
+        {"type" => "MediaFile", "id" => item2.id, "score" => 0.0078}
+      ].to_json
+
+      Net::HTTP.expects(:get_response).returns(mock(body: json))
+      MediaFile.expects(:where).with({id: [item.id, item2.id]}).returns([item, item2])
+      items = Recommender.new(item).recommend
+      assert_equal [item, item2], items
+    end
+
+    def test_should_limit_correctly
+      items = 6.times.map { |x| MediaFile.new({id: x}) }
+      json = items.map {|item| {"type" => "MediaFile", "id" => item.id, "score" => 0.0097} }.to_json
+
+      Net::HTTP.expects(:get_response).returns(mock(body: json))
+      MediaFile.expects(:where).with({id: items[0..2].map(&:id)}).returns(items[0..2])
+      results = Recommender.new(item, limit: 3).recommend
+    end
+
+    def test_should_log_an_exception
+      Net::HTTP.expects(:get_response).raises(StandardError)
+      MeducationSDK.config.logger.expects(:error).with("!!Recommender Error!!")
+      MeducationSDK.config.logger.expects(:error).with("StandardError")
+      Recommender.new(item).recommend
+    end
+
+    def test_should_catch_an_exception_and_render_backup_recommendations
+      skip
+      recommendation = Item::Recommendation.create!(
+        item_type: item.class.name, item_id: item.id, jaccard_similarity: 1,
+        recommendation_type: item2.class.name, recommendation_id: item2.id
+      )
+      Net::HTTP.expects(:get_response).raises(StandardError)
+      items = Recommender.new(item).recommend
+      assert_equal [item2], items
+    end
+  end
+end

data/test/test_helper.rb

@@ -23,7 +23,7 @@ class Minitest::Test
       config.logger = MeducationSDK.config.logger
       config.access_id = "Sermo"
       config.secret_key = "foobar"
-      config.endpoint = "http://localhost:3000/system"
+      config.endpoint = "http://localhost:3000/spi"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meducation_sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.6.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,14 +70,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,14 +98,14 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Meducation's SDK
@@ -125,6 +125,7 @@ files:
 - Rakefile
 - lib/meducation_sdk.rb
 - lib/meducation_sdk/configuration.rb
+- lib/meducation_sdk/helpers.rb
 - lib/meducation_sdk/mocker.rb
 - lib/meducation_sdk/resource.rb
 - lib/meducation_sdk/resources/author.rb
@@ -176,10 +177,12 @@ files:
 - lib/meducation_sdk/resources/user_email_data.rb
 - lib/meducation_sdk/resources/user_settings.rb
 - lib/meducation_sdk/resources/vote.rb
+- lib/meducation_sdk/services/recommender.rb
 - lib/meducation_sdk/version.rb
 - meducation_sdk.gemspec
 - test/arbitary_test.rb
 - test/configuration_test.rb
+- test/helpers_test.rb
 - test/mocker_test.rb
 - test/resource_test.rb
 - test/resources/author_test.rb
@@ -231,6 +234,7 @@ files:
 - test/resources/user_settings_test.rb
 - test/resources/user_test.rb
 - test/resources/vote_test.rb
+- test/services/recommender_test.rb
 - test/test_helper.rb
 homepage: http://github.com/meducation/meducation_sdk
 licenses:
@@ -242,23 +246,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: The SDK for Meducation
 test_files:
 - test/arbitary_test.rb
 - test/configuration_test.rb
+- test/helpers_test.rb
 - test/mocker_test.rb
 - test/resource_test.rb
 - test/resources/author_test.rb
@@ -310,4 +315,5 @@ test_files:
 - test/resources/user_settings_test.rb
 - test/resources/user_test.rb
 - test/resources/vote_test.rb
+- test/services/recommender_test.rb
 - test/test_helper.rb