meducation_sdk 0.1.0

data/README.md

@@ -0,0 +1,73 @@
+# Meducation SDK
+
+[![Build Status](https://travis-ci.org/meducation/meducation_sdk.png)](https://travis-ci.org/meducation/meducation_sdk)
+[![Dependencies](https://gemnasium.com/meducation/meducation_sdk.png?travis)](https://gemnasium.com/meducation/meducation_sdk)
+[![Code Climate](https://codeclimate.com/github/meducation/meducation_sdk.png)](https://codeclimate.com/github/meducation/meducation_sdk)
+
+A wrapper for Meducation's SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meducation_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Resources accept the following methods:
+
+```ruby
+MeducationSDK::MediaFile.find(id)
+MeducationSDK::MediaFile.find_each #=> do ... end
+MeducationSDK::MediaFile.where(foo: 'bar') #=> do ... end
+MeducationSDK::MediaFile.create(foo: 'bar')
+```
+
+The following objects are currently supported:
+
+```ruby
+MediaFile
+User
+ItemComment
+```
+
+### Is it any good?
+
+[Yes.](http://news.ycombinator.com/item?id=3067434)
+
+## Contributing
+
+Firstly, thank you!! :heart::sparkling_heart::heart:
+
+We'd love to have you involved. Please read our [contributing guide](https://github.com/meducation/propono/tree/master/CONTRIBUTING.md) for information on how to get stuck in.
+
+### Contributors
+
+This project is managed by the [Meducation team](http://company.meducation.net/about#team). 
+
+These individuals have come up with the ideas and written the code that made this possible:
+
+- [Jeremy Walker](http://github.com/iHID)
+
+## Licence
+
+Copyright (C) 2013 New Media Education Ltd
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+A copy of the GNU Affero General Public License is available in [Licence.md](https://github.com/meducation/propono/blob/master/LICENCE.md)
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+task default: :test
+

data/lib/meducation_sdk/configuration.rb

@@ -0,0 +1,35 @@
+module MeducationSDK
+  class MeducationSDKError < StandardError
+  end
+  class MeducationSDKConfigurationError < MeducationSDKError
+  end
+
+  class Configuration
+
+    SETTINGS = [
+      :logger, :access_id, :secret_key, :endpoint
+    ]
+
+    attr_writer *SETTINGS
+
+    def initialize
+      Filum.config do |config|
+        config.logfile = "./log/loquor.log"
+      end
+      logger = Filum.logger
+    end
+
+    SETTINGS.each do |setting|
+      define_method setting do
+        get_or_raise(setting)
+      end
+    end
+
+    private
+
+    def get_or_raise(setting)
+      instance_variable_get("@#{setting.to_s}") ||
+        raise(MeducationSDKConfigurationError.new("Configuration for #{setting} is not set"))
+    end
+  end
+end

data/lib/meducation_sdk/mocker.rb

@@ -0,0 +1,56 @@
+module MeducationSDK
+  class Mocker
+    def self.mock!
+      RESOURCES.each do |resource|
+        new(resource).mock!
+      end
+    end
+
+    def self.unmock!
+      RESOURCES.each do |resource|
+        new(resource).unmock!
+      end
+    end
+
+    def initialize(resource_name)
+      @resource_name = resource_name
+    end
+
+    def mock!
+      return if MeducationSDK.const_defined?(original_klass)
+
+      resource = "MeducationSDK::#{resource_klass}".constantize
+      mock = "MeducationSDK::#{mock_klass}".constantize
+
+      MeducationSDK.const_set(original_klass, resource)
+      MeducationSDK.send(:remove_const, resource_klass)
+      MeducationSDK.const_set(resource_klass, mock)
+      MeducationSDK.send(:remove_const, mock_klass)
+    end
+
+    def unmock!
+      return unless MeducationSDK.const_defined?(original_klass)
+
+      original = "MeducationSDK::#{original_klass}".constantize
+      resource = "MeducationSDK::#{resource_klass}".constantize
+
+      MeducationSDK.const_set(mock_klass, resource)
+      MeducationSDK.send(:remove_const, resource_klass)
+      MeducationSDK.const_set(resource_klass, original)
+      MeducationSDK.send(:remove_const, original_klass)
+    end
+
+    private
+    def resource_klass
+      @resource_name.classify
+    end
+
+    def mock_klass
+       "#{@resource_name}_mock".classify
+    end
+
+    def original_klass
+      "#{@resource_name}_original".classify
+    end
+  end
+end

data/lib/meducation_sdk/resources/item_comment.rb

@@ -0,0 +1,20 @@
+module MeducationSDK
+  class ItemComment < Loquor::Resource
+    self.path = "/item_comments"
+
+    def item
+      @item ||= "MeducationSDK::#{item_type}".constantize.find(item_id)
+    end
+  end
+
+  class ItemCommentMock < ItemComment
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      user_id: 8,
+      item_id: 5, item_type: "MediaFile",
+      parsed_content: "Foobar"
+    }
+  end
+end

data/lib/meducation_sdk/resources/media_file.rb

@@ -0,0 +1,23 @@
+module MeducationSDK
+  class MediaFile < Loquor::Resource
+    self.path = "/media_files"
+
+    def user
+      @user ||= User.find(user_id)
+    end
+
+    def comments
+      @comments ||= ItemComment.where(item_id: id, item_type: "MediaFile")
+    end
+  end
+
+  class MediaFileMock < MediaFile
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1, 
+      user_id: 1,
+      title: "Abdominal Ultrasound Tutorial"
+    }
+  end
+end

data/lib/meducation_sdk/resources/mesh_heading.rb

@@ -0,0 +1,20 @@
+module MeducationSDK
+  class MeshHeading < Loquor::Resource
+    self.path = "/partners"
+
+    def parents
+      MeshHeading.where(id: parent_ids)
+    end
+  end
+
+  class MeshHeadingMock < MeshHeading
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      name: "Some Mesh Heading",
+      parent_ids: [2,3,4]
+    }
+  end
+end
+

data/lib/meducation_sdk/resources/mnemonic.rb

@@ -0,0 +1,15 @@
+module MeducationSDK
+  class Mnemonic < Loquor::Resource
+    self.path = "/partners"
+  end
+
+  class MnemonicMock < Mnemonic
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      subject: "Some interesting topic",
+      mnemonic_string: "SIT"
+    }
+  end
+end

data/lib/meducation_sdk/resources/notification.rb

@@ -0,0 +1,25 @@
+module MeducationSDK
+  class Notification < Loquor::Resource
+    self.path = "/notifications"
+
+    def item
+      @item ||= "MeducationSDK::#{item_type}".constantize.find(item_id)
+    end
+
+    def user
+      @user ||= User.find(user_id)
+    end
+  end
+
+  class NotificationMock < ItemComment
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      notification: "foobar",
+      user_id: 5,
+      item_id: 3,
+      item_type: "Comment"
+    }
+  end
+end

data/lib/meducation_sdk/resources/partner.rb

@@ -0,0 +1,15 @@
+module MeducationSDK
+  class Partner < Loquor::Resource
+    self.path = "/partners"
+  end
+
+  class PartnerMock < Partner
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      name: "Medical Protection Society",
+      abbreviated_name: "Medical Protection Society"
+    }
+  end
+end

data/lib/meducation_sdk/resources/premium_tutorial.rb

@@ -0,0 +1,14 @@
+module MeducationSDK
+  class PremiumTutorial < Loquor::Resource
+    self.path = "/premium_tutorials"
+  end
+
+  class PremiumTutorialMock < PremiumTutorial
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      title: "Al's Medicine Tutorial",
+    }
+  end
+end

data/lib/meducation_sdk/resources/syllabus_item.rb

@@ -0,0 +1,15 @@
+module MeducationSDK
+  class SyllabusItem < Loquor::Resource
+    self.path = "/syllabus_items"
+  end
+
+  class SyllabusItemMock < SyllabusItem
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      name: "Medicine",
+    }
+  end
+end
+

data/lib/meducation_sdk/resources/user.rb

@@ -0,0 +1,14 @@
+module MeducationSDK
+  class User < Loquor::Resource
+    self.path = "/users"
+  end
+
+  class UserMock < User
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      name: "Jeremy Walker"
+    }
+  end
+end

data/lib/meducation_sdk/version.rb

@@ -0,0 +1,3 @@
+module MeducationSDK
+  VERSION = "0.1.0"
+end

data/lib/meducation_sdk.rb

@@ -0,0 +1,60 @@
+require 'active_support/all'
+require 'loquor'
+
+require "meducation_sdk/version"
+require "meducation_sdk/configuration"
+require "meducation_sdk/mocker"
+
+RESOURCES = %w{
+  item_comment
+  media_file
+  mesh_heading
+  mnemonic
+  notification
+  partner
+  premium_tutorial
+  syllabus_item
+  user
+}
+RESOURCES.each do |resource|
+  require "meducation_sdk/resources/#{resource}"
+end
+
+module MeducationSDK
+  def self.config
+    @config ||= Configuration.new
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+
+  def self.mock!
+    MeducationSDK::Mocker.mock!
+  end
+end
+
+=begin
+  Interactors = {
+    "Group::Discussion"     => "/group_discussions",
+    "Group::DiscussionPost" => "/group_discussion_posts",
+    "Item::Comment"         => "/item_comments",
+    "MediaFile"             => "/media_files",
+    "MeshHeading"           => "/mesh_headings",
+    "Mnemonic"              => "/mnemonics",
+    "Premium::Tutorial"     => "/premium_tutorials",
+    "Partner"               => "/partners",
+    "SyllabusItem"          => "/syllabus_items",
+    "User"                  => "/users"
+    #
+    #ExamRoom::Practice::Exam::Challenge
+    #Friendship
+    #Ecommerce::Subscription
+    #Message.find
+    #Group::Membership
+    #Group::Invite
+    #KnowledgeBank::Answer
+    #User::Friendship
+  }
+=end

data/meducation_sdk.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meducation_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "meducation_sdk"
+  spec.version       = MeducationSDK::VERSION
+  spec.authors       = ["Jeremy Walker"]
+  spec.email         = ["jez.walker@gmail.com"]
+  spec.description   = "Meducation's SDK"
+  spec.summary       = "The SDK for Meducation"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "activesupport", '~> 3.2.15'
+  spec.add_dependency "loquor", '~> 0.3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest", '~> 5.0.8'
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rake"
+end

data/test/mocker_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module MeducationSDK
+  class MockerTest < Minitest::Test
+
+    def test_mock_switches_classes
+      MeducationSDK.mock!
+      assert MeducationSDK.const_defined?(:MediaFileOriginal)
+      assert MeducationSDK.const_defined?(:MediaFile)
+      refute MeducationSDK.const_defined?(:MediaFileMock)
+    ensure
+      MeducationSDK::Mocker.unmock!
+    end
+
+    def test_mock_substitutes_in_mock_classes
+      MeducationSDK.mock!
+
+      id = 5
+      Loquor::HttpAction::Get.expects(:get).never
+      assert id, MediaFile.find('id').id
+    ensure
+      MeducationSDK::Mocker.unmock!
+    end
+
+    def test_mock_sample_returns_media_file_with_attributes
+      MeducationSDK.mock!
+
+      media_file = MediaFile.sample
+      media_file.title.should == "Abdominal Ultrasound Tutorial"
+    ensure
+      MeducationSDK::Mocker.unmock!
+    end
+  end
+end

data/test/resource_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../test_helper', __FILE__)
+module MeducationSDK
+  class ResourceTest < Minitest::Test
+    def self.test_resource(klass, url)
+      define_method :klass do klass end
+      define_method :url do url end
+
+      class_eval do
+        def test_path
+          assert_equal url, klass.path
+        end
+
+        def test_generates_find_url
+          id = 7
+          Loquor::HttpAction::Get.expects(:get).with("#{url}/#{id}", anything())
+          klass.find(id)
+        end
+      end
+    end
+  end
+end

data/test/resources/item_comment_test.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../../test_helper', __FILE__)
+require File.expand_path('../../resource_test', __FILE__)
+
+module MeducationSDK
+  class ItemCommentTest < ResourceTest
+    test_resource(ItemComment, '/item_comments')
+
+    def test_item_calls_sdk
+      comment = ItemComment.new(item_id: 2, item_type: "MediaFile")
+      MeducationSDK::MediaFile.expects(:find).with(2)
+      comment.item
+    end
+  end
+end
+

data/test/resources/media_file_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../../test_helper', __FILE__)
+require File.expand_path('../../resource_test', __FILE__)
+
+module MeducationSDK
+  class MediaFileTest < ResourceTest
+    test_resource(MediaFile, '/media_files')
+
+    def test_user_calls_sdk
+      media_file = MediaFile.new(user_id: 3)
+      MeducationSDK::User.expects(:find).with(3)
+      media_file.user
+    end
+  end
+end

data/test/resources/user_test.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../test_helper', __FILE__)
+require File.expand_path('../../resource_test', __FILE__)
+
+module MeducationSDK
+  class UserTest < ResourceTest
+    test_resource(User, '/users')
+  end
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+gem "minitest"
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/mock"
+require "mocha/setup"
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "meducation_sdk"
+
+class Minitest::Test
+  def setup
+    MeducationSDK.config do |config|
+      config.logger = mock()
+      config.logger.stubs(:debug)
+      config.logger.stubs(:info)
+      config.logger.stubs(:error)
+    end
+    Loquor.config do |config|
+      config.logger = MeducationSDK.config.logger
+      config.access_id = "Sermo"
+      config.secret_key = "foobar"
+      config.endpoint = "http://localhost:3000"
+    end
+  end
+end
+