binder_sdk 0.0.1

data/README.md

@@ -0,0 +1,72 @@
+# Binder SDK
+
+[![Build Status](https://travis-ci.org/meducation/binder_sdk.png)](https://travis-ci.org/meducation/binder_sdk)
+[![Dependencies](https://gemnasium.com/meducation/binder_sdk.png?travis)](https://gemnasium.com/meducation/binder_sdk)
+[![Code Climate](https://codeclimate.com/github/meducation/binder_sdk.png)](https://codeclimate.com/github/meducation/binder_sdk)
+
+A wrapper for Binder's SDK.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'binder_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Resources accept the following methods:
+
+```ruby
+BinderSDK::MediaFile.find(id)
+BinderSDK::MediaFile.find_each #=> do ... end
+BinderSDK::MediaFile.where(foo: 'bar') #=> []
+BinderSDK::MediaFile.where(foo: 'bar').select([:id, :name]) #=> []
+BinderSDK::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/binder_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 'binder_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "binder_sdk"
+  spec.version       = BinderSDK::VERSION
+  spec.authors       = ["Jeremy Walker"]
+  spec.email         = ["jez.walker@gmail.com"]
+  spec.description   = "Binder's SDK"
+  spec.summary       = "The SDK for Binder"
+  spec.homepage      = "http://github.com/meducation/binder_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/lib/binder_sdk/configuration.rb

@@ -0,0 +1,43 @@
+module BinderSDK
+  class BinderSDKError < StandardError
+  end
+  class BinderSDKConfigurationError < BinderSDKError
+  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(BinderSDKConfigurationError.new("Configuration for #{setting} is not set"))
+    end
+  end
+end

data/lib/binder_sdk/email_shortcodes.rb

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

data/lib/binder_sdk/helpers.rb

@@ -0,0 +1,27 @@
+module BinderSDK
+  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
+        "BinderSDK::#{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("BinderSDK::", "")
+      end
+    end
+  end
+end
+

data/lib/binder_sdk/mocker.rb

@@ -0,0 +1,72 @@
+module BinderSDK
+  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
+          "BinderSDK"
+        else
+          parts.pop
+          "BinderSDK::#{parts.join("::")}"
+        end
+      end
+    end
+  end
+end

data/lib/binder_sdk/resource.rb

@@ -0,0 +1,26 @@
+module BinderSDK
+  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{
+  user
+}
+
+require "binder_sdk/resources/user"
+RESOURCES.each do |resource|
+  require "binder_sdk/resources/#{resource}"
+end

data/lib/binder_sdk/resources/user.rb

@@ -0,0 +1,23 @@
+module BinderSDK
+  class User < Resource
+    self.path = "/users"
+  end
+
+  class UserMock < User
+    extend Loquor::ResourceMock
+
+    self.attributes = {
+      id: 1,
+      first_name: "Jeremy",
+      surname: "Walker",
+      name: "Jeremy Walker",
+      short_display_name: "Jeremy",
+      photo_url: "http://i.telegraph.co.uk/multimedia/archive/02351/cross-eyed-cat_2351472k.jpg",
+      primary_email_address: "jez.walker@gmail.com",
+      url_code: "asd1234567",
+      is_site_admin: false,
+      reputation: 1023,
+      viewable_collections: []
+    }
+  end
+end

data/lib/binder_sdk/version.rb

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

data/lib/binder_sdk.rb

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

data/test/arbitary_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+module BinderSDK
+  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 BinderSDK
+  class ConfigurationTest < Minitest::Test
+
+    def setup
+      super
+      BinderSDK.instance_variable_set("@config", nil)
+    end
+
+    def test_obtaining_singletion
+      refute BinderSDK.config.nil?
+    end
+
+    def test_block_syntax
+      test_key = "foobar-123-access"
+      BinderSDK.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"
+      BinderSDK.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"
+      BinderSDK.config.secret_key = key
+      assert_equal key, Loquor.config.secret_key
+    end
+
+    def test_cache_proxies_to_loquor
+      cache = mock()
+      BinderSDK.config.cache = cache
+      assert_equal cache, Loquor.config.cache
+    end
+  end
+end

data/test/mocker_test.rb

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

data/test/resource_test.rb

@@ -0,0 +1,30 @@
+require_relative 'test_helper'
+module BinderSDK
+  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/user_test.rb

@@ -0,0 +1,10 @@
+require_relative '../test_helper'
+require_relative '../resource_test'
+
+module BinderSDK
+  class UserTest < ResourceTest
+    test_resource(User, '/users')
+  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 'binder_sdk'
+require_relative 'resources/user_test.rb'
+
+class Minitest::Test
+  def setup
+    Filum.setup("./log/test.log")
+    BinderSDK.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 = BinderSDK.config.logger
+      config.access_id = "Sermo"
+      config.secret_key = "foobar"
+      config.endpoint = "http://localhost:3000/spi"
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: binder_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+- !ruby/object:Gem::Dependency
+  name: loquor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: filum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  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: Binder's SDK
+email:
+- jez.walker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENCE.md
+- README.md
+- Rakefile
+- binder_sdk.gemspec
+- lib/binder_sdk.rb
+- lib/binder_sdk/configuration.rb
+- lib/binder_sdk/email_shortcodes.rb
+- lib/binder_sdk/helpers.rb
+- lib/binder_sdk/mocker.rb
+- lib/binder_sdk/resource.rb
+- lib/binder_sdk/resources/user.rb
+- lib/binder_sdk/version.rb
+- test/arbitary_test.rb
+- test/configuration_test.rb
+- test/mocker_test.rb
+- test/resource_test.rb
+- test/resources/user_test.rb
+- test/test_helper.rb
+homepage: http://github.com/meducation/binder_sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: The SDK for Binder
+test_files:
+- test/arbitary_test.rb
+- test/configuration_test.rb
+- test/mocker_test.rb
+- test/resource_test.rb
+- test/resources/user_test.rb
+- test/test_helper.rb