ordino_sdk 0.0.6

data/README.md

@@ -0,0 +1,72 @@
+# Ordino SDK
+
+[![Build Status](https://travis-ci.org/meducation/ordino_sdk.png)](https://travis-ci.org/meducation/ordino_sdk)
+[![Dependencies](https://gemnasium.com/meducation/ordino_sdk.png?travis)](https://gemnasium.com/meducation/ordino_sdk)
+[![Code Climate](https://codeclimate.com/github/meducation/ordino_sdk.png)](https://codeclimate.com/github/meducation/ordino_sdk)
+
+A wrapper for Ordino's SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ordino_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Resources accept the following methods:
+
+```ruby
+OrdinoSDK::MediaFile.find(id)
+OrdinoSDK::MediaFile.find_each #=> do ... end
+OrdinoSDK::MediaFile.where(foo: 'bar') #=> []
+OrdinoSDK::MediaFile.where(foo: 'bar').select([:id, :name]) #=> []
+OrdinoSDK::MediaFile.create(foo: 'bar')
+```
+
+The following objects are currently supported:
+
+```ruby
+User
+```
+
+### 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/ordino_sdk/configuration.rb

@@ -0,0 +1,43 @@
+module OrdinoSDK
+  class OrdinoSDKError < StandardError
+  end
+  class OrdinoSDKConfigurationError < OrdinoSDKError
+  end
+
+  class Configuration
+
+    SETTINGS = [ 
+      :logger
+    ]
+
+    attr_writer *SETTINGS
+
+    def initialize
+      self.logger = Filum.logger
+    end
+
+    [:access_id, :secret_key, :endpoint, :cache].each do |setting|
+      define_method "#{setting}=" do |val|
+        Loquor.config.send("#{setting}=", val)
+      end
+    end
+
+    def logger=(val)
+      @logger = val
+      Loquor.config.logger = val
+    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(OrdinoSDKConfigurationError.new("Configuration for #{setting} is not set"))
+    end
+  end
+end

data/lib/ordino_sdk/email_shortcodes.rb

@@ -0,0 +1,6 @@
+module OrdinoSDK
+  EmailShortcodes = {
+    "b_nwusr"   => "New User",
+    "b_pswdr"   => "Password Reset"
+  }
+end

data/lib/ordino_sdk/helpers.rb

@@ -0,0 +1,27 @@
+module OrdinoSDK
+  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
+        "OrdinoSDK::#{spi_type.gsub("::", "")}"
+      end
+    end
+
+    def spi_type_for(sdk_type)
+      sdk_type = sdk_type.gsub(/Mock$/, "")
+      if SDK_TO_SPI_MAPPINGS.has_key?(sdk_type)
+        SDK_TO_SPI_MAPPINGS[sdk_type]
+      else
+        sdk_type.gsub("OrdinoSDK::", "")
+      end
+    end
+  end
+end
+

data/lib/ordino_sdk/mocker.rb

@@ -0,0 +1,72 @@
+module OrdinoSDK
+  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 mock_module.const_defined?(original_class_name)
+
+      resource = "#{mock_module_name}::#{resource_class_name}".constantize
+      mock = "#{mock_module_name}::#{mock_class_name}".constantize
+
+      mock_module.const_set(original_class_name, resource)
+      mock_module.send(:remove_const, resource_class_name)
+      mock_module.const_set(resource_class_name, mock)
+      mock_module.send(:remove_const, mock_class_name)
+    end
+
+    def unmock!
+      return unless mock_module.const_defined?(original_class_name)
+
+      original = "#{mock_module_name}::#{original_class_name}".constantize
+      resource = "#{mock_module_name}::#{resource_class_name}".constantize
+
+      mock_module.const_set(mock_class_name, resource)
+      mock_module.send(:remove_const, resource_class_name)
+      mock_module.const_set(resource_class_name, original)
+      mock_module.send(:remove_const, original_class_name)
+    end
+
+    private
+    def resource_class_name
+      @resource_class_name ||= @resource_name.camelize.split("::").last
+    end
+
+    def mock_class_name
+       @mock_class_name ||= "#{@resource_name}_mock".camelize.split("::").last
+    end
+
+    def original_class_name
+      @original_class_name ||= "#{@resource_name}_original".camelize.split("::").last
+    end
+
+    def mock_module
+      @mock_module ||= mock_module_name.constantize
+    end
+
+    def mock_module_name
+      @mock_module_name ||= begin
+        parts = @resource_name.camelize.split("::")
+        if parts.size == 1
+          "OrdinoSDK"
+        else
+          parts.pop
+          "OrdinoSDK::#{parts.join("::")}"
+        end
+      end
+    end
+  end
+end

data/lib/ordino_sdk/resource.rb

@@ -0,0 +1,26 @@
+module OrdinoSDK
+  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
+
+    def updated_at
+      DateTime.parse(@data[:updated_at])
+    end
+  end
+end
+
+RESOURCES = %w{
+  entry
+  user
+  web_page
+}
+RESOURCES.each do |resource|
+  require "ordino_sdk/resources/#{resource}"
+end

data/lib/ordino_sdk/resources/entry.rb

@@ -0,0 +1,26 @@
+module OrdinoSDK
+  class Entry < Resource
+    self.path = "/entries"
+
+    def user
+      @user ||= User.find(user_id)
+    end
+
+    def resource
+      @resource ||= sdk_class_for(resource_type).find(resource_id)
+    end
+  end
+
+  class EntryMock < Entry
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 50,
+      user_id: 30660,
+      resource_type: "WebPage",
+      resource_id: 17,
+      binder_id: 11,
+      order_value: 100
+    }
+  end
+end

data/lib/ordino_sdk/resources/user.rb

@@ -0,0 +1,15 @@
+module OrdinoSDK
+  class User < Resource
+    self.path = "/users"
+  end
+
+  class UserMock < User
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      email: "jez.walker@gmail.com",
+      name: "Jeremy Walker"
+    }
+  end
+end

data/lib/ordino_sdk/resources/web_page.rb

@@ -0,0 +1,27 @@
+module OrdinoSDK
+  class WebPage < Resource
+    self.path = "/web_pages"
+
+    def entries
+      Entry.where(resource_type: "WebPage", resource_id: self.id)
+    end
+
+    def self.reimport_metadata(id)
+      new Loquor.post("#{path}/#{id}/reimport_metadata", {})
+    end
+
+  end
+
+  class WebPageMock < WebPage
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      created_by_id: 1,
+      site_name: 'FooTube',
+      url: 'http://footube.example.com/foo/bar',
+      title: 'Foo Bar Baz',
+      description: 'The Foo Bar Baz mock external resource is a great FooTube video.'
+    }
+  end
+end

data/lib/ordino_sdk/version.rb

@@ -0,0 +1,3 @@
+module OrdinoSDK
+  VERSION = "0.0.6"
+end

data/lib/ordino_sdk.rb

@@ -0,0 +1,25 @@
+require 'active_support/all'
+require 'loquor'
+
+require 'ordino_sdk/version'
+require 'ordino_sdk/configuration'
+require 'ordino_sdk/mocker'
+
+require 'ordino_sdk/helpers'
+require 'ordino_sdk/resource'
+require 'ordino_sdk/email_shortcodes'
+
+module OrdinoSDK
+  def self.config
+    @config ||= Configuration.new
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+
+  def self.mock!
+    OrdinoSDK::Mocker.mock!
+  end
+end

data/ordino_sdk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ordino_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ordino_sdk"
+  spec.version       = OrdinoSDK::VERSION
+  spec.authors       = ["Jeremy Walker"]
+  spec.email         = ["jez.walker@gmail.com"]
+  spec.description   = "Ordino's SDK"
+  spec.summary       = "The SDK for Ordino"
+  spec.homepage      = "http://github.com/meducation/ordino_sdk"
+  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", '~> 1.2'
+  spec.add_dependency "filum", '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", '~> 5.0.8'
+  spec.add_development_dependency "mocha"
+end

data/test/arbitary_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+module OrdinoSDK
+  class ArbitaryTest < Minitest::Test
+    def test_shit_happens
+      skip
+      MediaFile.update(8, title: "Foobar to the Malcy Max")
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,51 @@
+require_relative 'test_helper'
+
+module OrdinoSDK
+  class ConfigurationTest < Minitest::Test
+
+    def setup
+      super
+      OrdinoSDK.instance_variable_set("@config", nil)
+    end
+
+    def test_obtaining_singletion
+      refute OrdinoSDK.config.nil?
+    end
+
+    def test_block_syntax
+      test_key = "foobar-123-access"
+      OrdinoSDK.config do |config|
+        config.access_id = test_key
+      end
+      assert_equal test_key, Loquor.config.access_id
+    end
+
+    def test_endpoint_is_set_correctly
+      Configuration.new
+      assert_equal "http://localhost:3000/spi", Loquor.config.endpoint
+    end
+
+    def test_retry_404s_is_set_correctly
+      Configuration.new
+      assert_equal false, Loquor.config.retry_404s
+    end
+
+    def test_access_id_proxies_to_loquor
+      access_id = "test-access-id"
+      OrdinoSDK.config.access_id = access_id
+      assert_equal access_id, Loquor.config.access_id
+    end
+
+    def test_secret_key_proxies_to_loquor
+      key = "test-secret-key"
+      OrdinoSDK.config.secret_key = key
+      assert_equal key, Loquor.config.secret_key
+    end
+
+    def test_cache_proxies_to_loquor
+      cache = mock()
+      OrdinoSDK.config.cache = cache
+      assert_equal cache, Loquor.config.cache
+    end
+  end
+end

data/test/mocker_test.rb

@@ -0,0 +1,35 @@
+require_relative 'test_helper'
+
+module OrdinoSDK
+  class MockerTest < Minitest::Test
+
+    def test_mock_switches_classes
+      OrdinoSDK.mock!
+      assert OrdinoSDK.const_defined?(:UserOriginal)
+      assert OrdinoSDK.const_defined?(:User)
+      refute OrdinoSDK.const_defined?(:UserMock)
+    ensure
+      OrdinoSDK::Mocker.unmock!
+    end
+
+    def test_mock_substitutes_in_mock_classes
+      OrdinoSDK.mock!
+
+      id = 1
+      Loquor::HttpAction::Get.expects(:get).never
+      assert id, User.find('id').id
+    ensure
+      OrdinoSDK::Mocker.unmock!
+    end
+
+    def test_mock_sample_returns_media_file_with_attributes
+      OrdinoSDK.mock!
+
+      user = User.sample
+      assert_equal user.email, "jez.walker@gmail.com"
+      assert_equal user.name, "Jeremy Walker"
+    ensure
+      OrdinoSDK::Mocker.unmock!
+    end
+  end
+end

data/test/resource_test.rb

@@ -0,0 +1,30 @@
+require_relative 'test_helper'
+module OrdinoSDK
+  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
+    define_method 'test_helpers_included' do
+      assert Resource.new({}).respond_to?(:sdk_class_for)
+    end
+
+    def test_created_at_is_a_datetime
+      resource = Resource.new(created_at: '2014-02-23T23:34:49Z')
+      assert resource.created_at.is_a?(DateTime)
+      assert_equal DateTime.new(2014, 2, 23, 23, 34, 49), resource.created_at
+    end
+  end
+end

data/test/resources/entry_test.rb

@@ -0,0 +1,20 @@
+require_relative '../test_helper'
+require_relative '../resource_test'
+
+module OrdinoSDK
+  class EntryTest < ResourceTest
+    test_resource(Entry, '/entries')
+
+    def test_user_calls_sdk
+      entry = Entry.new(user_id: 2)
+      OrdinoSDK::User.expects(:find).with(2)
+      entry.user
+    end
+
+    def test_resource_calls_sdk
+      entry = Entry.new(resource_id: 2, resource_type: "WebPage")
+      OrdinoSDK::WebPage.expects(:find).with(2)
+      entry.resource
+    end
+  end
+end

data/test/resources/user_test.rb

@@ -0,0 +1,10 @@
+require_relative '../test_helper'
+require_relative '../resource_test'
+
+module OrdinoSDK
+  class UserTest < ResourceTest
+    test_resource(User, '/users')
+  end
+end
+
+

data/test/resources/web_page_test.rb

@@ -0,0 +1,15 @@
+require_relative '../test_helper'
+require_relative '../resource_test'
+
+module OrdinoSDK
+  class WebPageTest < ResourceTest
+    test_resource(WebPage, '/web_pages')
+
+    def test_can_retrigger_metadata_load
+      Loquor.expects(:post).with('/web_pages/12/reimport_metadata', {})
+      WebPage.reimport_metadata(12)
+    end
+  end
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+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 'ordino_sdk'
+require_relative 'resources/user_test.rb'
+
+class Minitest::Test
+  def setup
+    Filum.setup("./log/test.log")
+    OrdinoSDK.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 = OrdinoSDK.config.logger
+      config.access_id = "Sermo"
+      config.secret_key = "foobar"
+      config.endpoint = "http://localhost:3000/spi"
+    end
+  end
+end