loquor 0.0.1

data/lib/loquor/version.rb

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

data/loquor.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loquor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "loquor"
+  spec.version       = Loquor::VERSION
+  spec.authors       = ["Jeremy Walker"]
+  spec.email         = ["jez.walker@gmail.com"]
+  spec.description   = "An API dispatcher for Meducation"
+  spec.summary       = "This library dispatches requests to Meducation"
+  spec.homepage      = "https://www.meducation.net"
+  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 'filum', '0.0.1'
+  spec.add_dependency 'rest-client', '1.6.7'
+  spec.add_dependency "api-auth", "1.0.3"
+
+  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/api_calls/index_test.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Loquor
+  class ApiCall::IndexTest < Minitest::Test
+    def test_where_sets_criteria
+      criteria = {genre: 'Animation'}
+      searcher = ApiCall::Index.new('').where(criteria)
+      assert_equal({genre: 'Animation'}, searcher.criteria)
+    end
+
+    def test_where_merges_criteria
+      criteria1 = {genre: 'Animation'}
+      criteria2 = {foobar: 'Cat'}
+      searcher = ApiCall::Index.new('').where(criteria1).where(criteria2)
+      assert_equal({genre: 'Animation', foobar: 'Cat'}, searcher.criteria)
+    end
+
+    def test_where_overrides_criteria_with_same_key
+      criteria1 = {genre: 'Animation'}
+      criteria2 = {genre: 'Action'}
+      searcher = ApiCall::Index.new('').where(criteria1).where(criteria2)
+      assert_equal({genre: "Action"}, searcher.criteria)
+    end
+
+    def test_where_gets_correct_url
+      searcher = ApiCall::Index.new('').where(name: 'Star Wars')
+      assert searcher.send(:generate_url).include? "?name=Star%20Wars"
+    end
+
+    def test_where_works_with_array_in_a_hash
+      criteria = {thing: ['foo', 'bar']}
+      searcher = ApiCall::Index.new('').where(criteria)
+      assert_equal criteria, searcher.criteria
+    end
+
+    def test_that_iterating_calls_results
+      searcher = ApiCall::Index.new('').where(name: "star_wars")
+      searcher.expects(results: [])
+      searcher.each { }
+    end
+
+    def test_that_iterating_calls_each
+      Loquor.expects(:get).returns([{id: 8, name: "Star Wars"}])
+      searcher = ApiCall::Index.new('').where(name: "star_wars")
+      searcher.send(:results).expects(:each)
+      searcher.each { }
+    end
+
+    def test_that_select_calls_each
+      Loquor.expects(:get).returns([{id: 8, name: "Star Wars"}])
+      searcher = ApiCall::Index.new('').where(name: "star_wars")
+      searcher.send(:results).expects(:select)
+      searcher.select { }
+    end
+
+    def test_search_should_set_results
+      expected_results = [{id: 8, name: "Star Wars"}]
+      Loquor.expects(:get).returns(expected_results)
+
+      searcher = ApiCall::Index.new('').where(name: "star_wars")
+      searcher.to_a
+      assert_equal expected_results, searcher.instance_variable_get("@results")
+    end
+
+    def test_search_should_create_a_results_object
+      Loquor.expects(:get).returns([{id: 8, name: "Star Wars"}])
+      searcher = ApiCall::Index.new('').where(name: "star_wars")
+      searcher.to_a
+      assert Array, searcher.instance_variable_get("@results").class
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class ClientTest < Minitest::Test
+    def test_initialize_should_create_config
+      Configuration.expects(:new)
+      Client.new
+    end
+
+    def test_get_calls_gets
+      url = "foobar"
+
+      client = Client.new
+      deps = {config: client.config}
+      HttpAction::Get.expects(:get).with(url, deps)
+      client.get(url)
+    end
+
+    def test_post_calls_posts
+      url = "foobar"
+      payload = {x: true}
+
+      client = Client.new
+      deps = {config: client.config}
+      HttpAction::Post.expects(:post).with(url, payload, deps)
+      client.post(url, payload)
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class ConfigurationTest < Minitest::Test
+
+    def setup
+      Loquor.send(:loquor).instance_variable_set("@config", Configuration.new)
+    end
+
+    def test_obtaining_singletion
+      refute Loquor.config.nil?
+    end
+
+    def test_block_syntax
+      test_key = "foobar-123-access"
+      Loquor.config do |config|
+        config.access_id = test_key
+      end
+      assert_equal test_key, Loquor.config.access_id
+    end
+
+    def test_access_id
+      access_id = "test-access-key"
+      Loquor.config.access_id = access_id
+      assert_equal access_id, Loquor.config.access_id
+    end
+
+    def test_secret_key
+      secret_key = "test-secret-key"
+      Loquor.config.secret_key = secret_key
+      assert_equal secret_key, Loquor.config.secret_key
+    end
+
+    def test_endpoint
+      endpoint = "http://localhost:3000"
+      Loquor.config.endpoint = endpoint
+      assert_equal endpoint, Loquor.config.endpoint
+    end
+
+    def test_missing_access_id_throws_exception
+      assert_raises(LoquorConfigurationError) do
+        Loquor.config.access_id
+      end
+    end
+
+    def test_missing_secret_key_throws_exception
+      assert_raises(LoquorConfigurationError) do
+        Loquor.config.secret_key
+      end
+    end
+
+    def test_missing_endpoint_throws_exception
+      assert_raises(LoquorConfigurationError) do
+        Loquor.config.endpoint
+      end
+    end
+  end
+end

data/test/http_actions/get_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Loquor
+  class HttpAction::GetTest < Minitest::Test
+    def test_get_should_call_new
+      url = "foobar"
+      deps = {x: true}
+      HttpAction::Get.expects(:new).with(url, deps).returns(mock(get: nil))
+      HttpAction::Get.get(url, deps)
+    end
+
+    def test_get_should_call_get
+      HttpAction::Get.any_instance.expects(:get)
+      HttpAction::Get.get("foobar", {})
+    end
+
+    def test_get_parses_request
+      output = {'foo' => 'bar'}
+      json = output.to_json
+      gets = HttpAction::Get.new("", {})
+      gets.expects(signed_request: mock(execute: json))
+      assert_equal output, gets.get
+    end
+
+    def test_request_is_generated_correctly
+      url = "/foobar"
+      endpoint = "http://thefoobar.com"
+      config = mock(endpoint: endpoint)
+      full_url = "#{endpoint}#{url}"
+      deps = {config: config}
+
+      RestClient::Request.expects(:new).with(url: full_url, method: :get)
+      HttpAction::Get.new(url, deps).send(:request)
+    end
+
+    def test_request_is_signed_correctly
+      access_id = "foobar1"
+      secret_key = "foobar2"
+      config = mock(access_id: access_id, secret_key: secret_key)
+      deps = {config: config}
+
+      gets = HttpAction::Get.new("", deps)
+      request = RestClient::Request.new(url: "http://localhost:3000", method: :get)
+      gets.expects(request: request)
+      ApiAuth.expects(:sign!).with(request, access_id, secret_key)
+      gets.send(:signed_request)
+    end
+  end
+end

data/test/http_actions/post_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Loquor
+  class HttpAction::PostTest < Minitest::Test
+    def test_post_should_call_new
+      url = "foobar"
+      payload = {y: false}
+      deps = {x: true}
+      HttpAction::Post.expects(:new).with(url, payload, deps).returns(mock(post: nil))
+      HttpAction::Post.post(url, payload, deps)
+    end
+
+    def test_post_should_call_post
+      HttpAction::Post.any_instance.expects(:post)
+      HttpAction::Post.post("foobar", {}, {})
+    end
+
+    def test_post_parses_request
+      output = {'foo' => 'bar'}
+      json = output.to_json
+      posts = HttpAction::Post.new("", {}, {})
+      posts.expects(signed_request: mock(execute: json))
+      assert_equal output, posts.post
+    end
+
+    def test_request_is_generated_correctly
+      url = "/foobar"
+      payload = {foo: true, bar: false}
+      endpoint = "http://thefoobar.com"
+      config = mock(endpoint: endpoint)
+      full_url = "#{endpoint}#{url}"
+      deps = {config: config}
+
+      RestClient::Request.expects(:new).with(
+        url: full_url,
+        accept: :json,
+        payload: payload.to_json,
+        headers: {'Content-type' => 'application/json'},
+        method: :post
+      )
+      HttpAction::Post.new(url, payload, deps).send(:request)
+    end
+
+    def test_request_is_signed_correctly
+      access_id = "foobar1"
+      secret_key = "foobar2"
+      config = mock(access_id: access_id, secret_key: secret_key)
+      deps = {config: config}
+
+      posts = HttpAction::Post.new("", {}, deps)
+      request = RestClient::Request.new(url: "http://localhost:3000", method: :post)
+      posts.expects(request: request)
+      ApiAuth.expects(:sign!).with(request, access_id, secret_key)
+      posts.send(:signed_request)
+    end
+
+  end
+end
+

data/test/path_builder_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class PathBuilderTest < Minitest::Test
+    class SimplePathRepresentation
+      include PathBuilder
+
+      def initialize
+        setup_path_builder("/foobar123")
+      end
+    end
+
+    class ComplexPathRepresentation
+      include PathBuilder
+
+      def initialize
+        setup_path_builder("/groups/:group_id/discussions")
+      end
+    end
+
+    def test_find_should_get_correct_path_with_simple_path
+      id = 8
+      assert_equal "/foobar123", SimplePathRepresentation.new.send(:build_path)
+    end
+
+    def test_path_part_methods_are_created
+      rep = ComplexPathRepresentation.new
+      assert rep.respond_to?(:for_group_id)
+    end
+
+    def test_find_should_get_correct_path_with_complex_path
+      group_id = 5
+      rep = ComplexPathRepresentation.new
+      rep.for_group_id(5)
+      assert_equal "/groups/#{group_id}/discussions", rep.send(:build_path)
+    end
+
+    def test_find_should_get_raise_exception_without_path_parts
+      rep = ComplexPathRepresentation.new
+      assert_raises(Loquor::MissingUrlComponentError) do
+        rep.send :build_path
+      end
+    end
+  end
+end
+

data/test/representation_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class RepresentationTest < Minitest::Test
+    class FoobarRepresentation
+      extend Representation::ClassMethods
+      include Representation::InstanceMethods
+
+      def build_path
+        "/foobar"
+      end
+
+      def self.path
+        "/foobar"
+      end
+    end
+
+    def test_find_should_get_correct_path_with_simple_path
+      id = 8
+      Loquor.expects(:get).with("/foobar/#{id}")
+      FoobarRepresentation.find(id)
+    end
+
+    def test_where_should_get_correct_path_with_simple_path
+      email = "foobar"
+      Loquor.expects(:get).with("/foobar?email=#{email}")
+      FoobarRepresentation.where(email: email).to_a
+    end
+  end
+end

data/test/representations_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class RepresentationTest < Minitest::Test
+
+    {
+      MediaFile: "/media_files",
+      User: "/users"
+    }.each do |klass, path|
+      define_method "test_#{klass}_set_up_correctly" do
+        assert Loquor.const_defined?(klass)
+      end
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+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 "loquor"
+
+class Minitest::Test
+  def setup
+    Loquor.config do |config|
+      config.access_id = "Sermo"
+      config.secret_key = "foobar"
+      config.endpoint = "http://localhost:3000"
+
+      config.logger = mock()
+      config.logger.stubs(:debug)
+      config.logger.stubs(:info)
+      config.logger.stubs(:error)
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: loquor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: api-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !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: 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'
+- !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'
+description: An API dispatcher for Meducation
+email:
+- jez.walker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTING.md
+- Gemfile
+- LICENCE.md
+- README.md
+- Rakefile
+- lib/loquor.rb
+- lib/loquor/api_call.rb
+- lib/loquor/api_calls/index.rb
+- lib/loquor/api_calls/show.rb
+- lib/loquor/client.rb
+- lib/loquor/configuration.rb
+- lib/loquor/http_action.rb
+- lib/loquor/http_actions/get.rb
+- lib/loquor/http_actions/post.rb
+- lib/loquor/path_builder.rb
+- lib/loquor/representation.rb
+- lib/loquor/representations.rb
+- lib/loquor/version.rb
+- loquor.gemspec
+- test/api_calls/index_test.rb
+- test/client_test.rb
+- test/configuration_test.rb
+- test/http_actions/get_test.rb
+- test/http_actions/post_test.rb
+- test/path_builder_test.rb
+- test/representation_test.rb
+- test/representations_test.rb
+- test/test_helper.rb
+homepage: https://www.meducation.net
+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.1.9
+signing_key: 
+specification_version: 4
+summary: This library dispatches requests to Meducation
+test_files:
+- test/api_calls/index_test.rb
+- test/client_test.rb
+- test/configuration_test.rb
+- test/http_actions/get_test.rb
+- test/http_actions/post_test.rb
+- test/path_builder_test.rb
+- test/representation_test.rb
+- test/representations_test.rb
+- test/test_helper.rb
+has_rdoc: