loquor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 142cc1ea603cf63693180cc9bfbfc06b945bd4da
-  data.tar.gz: 13ff9f64e50a6a8b519aac540b044db429e00403
+  metadata.gz: a891916202c44567d39b1b214f39452edd263796
+  data.tar.gz: 815fbff4daaacbf2dc47e8ed248e6d2978338c68
 SHA512:
-  metadata.gz: ba7f6a1230c916c0781b6fbee30be68263ec72290629114f349629af158b376a5622c92b64d6da2d51e871e847d03167453176f0c3311b98199e98e443d98c9d
-  data.tar.gz: 541ddf933637340e1649aee35f4ac5d5333e46eea19c26f74a6d75f31b0dc8abb3741e2fd3c751cd25a56675eca435d700ae0e5112e1ecd35d7d5334d47ae9c6
+  metadata.gz: 99a10b205e5c4597d6405b29faeb2180a04bb5f59afda111926f73d28070d7f79deed65aef6eb02806c04e277e46146ddd70924c2079881345e5db4ad3d4a692
+  data.tar.gz: 2890c5bf49c393a1c0b46113c903eface6b5387637f945935b7e739152a745fa5671f17ea8a9a518e698dfd02cb2d2137b5f936729090bc9d72810b80ac1f2f9

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.2 / 2013-11-22
+
+* [FEATURE] Responses from JSON now response to dot syntax

data/lib/loquor.rb

@@ -5,6 +5,7 @@ require 'filum'
 require "loquor/version"
 require "loquor/configuration"
 require "loquor/client"
+require 'loquor/interactor'
 require 'loquor/representation'
 
 require 'loquor/api_call'
@@ -12,7 +13,7 @@ require "loquor/http_action"
 
 module Loquor
 
-  Representations = {
+  Interactors = {
     "GroupDiscussion"     => "/group_discussions",
     "GroupDiscussionPost" => "/group_discussion_posts",
     "MediaFile"           => "/media_files",
@@ -46,4 +47,4 @@ module Loquor
   end
 end
 
-require 'loquor/representations'
+require 'loquor/interactors'

data/lib/loquor/api_calls/index.rb

@@ -28,7 +28,7 @@ module Loquor
       begin
         results = Loquor.get("#{generate_url}&page=#{page}&per=#{per}")
         results.each do |result|
-          yield result
+          yield Representation.new(result)
         end
         page += 1
       end while(results.size == per)
@@ -38,7 +38,7 @@ module Loquor
 
     def results
       if @results.nil?
-        @results = Loquor.get(generate_url)
+        @results = Loquor.get(generate_url).map {|obj| Representation.new(obj)}
       end
       @results
     end

data/lib/loquor/api_calls/show.rb

@@ -7,7 +7,8 @@ module Loquor
     end
 
     def execute
-      Loquor.get("#{@path}/#{@id}")
+      obj = Loquor.get("#{@path}/#{@id}")
+      Representation.new(obj)
     end
   end
 end

data/lib/loquor/http_actions/get.rb

@@ -9,7 +9,7 @@ module Loquor
     end
 
     def get
-      @config.logger.info "Making GET request to: #{@url}"
+      @config.logger.info "Making GET request to: #{full_url}"
       response = JSON.parse(signed_request.execute)
       @config.logger.info "Signed request executed. Response: #{response}"
       response
@@ -17,8 +17,11 @@ module Loquor
 
     private
     def request
-      full_url = "#{@config.endpoint}#{@url}"
       RestClient::Request.new(url: full_url, method: :get)
     end
+
+    def full_url
+      "#{@config.endpoint}#{@url}"
+    end
   end
 end

data/lib/loquor/http_actions/post.rb

@@ -10,10 +10,10 @@ module Loquor
     end
 
     def post
-      @config.logger.info "Making POST request to: #{@url}"
+      @config.logger.info "Making POST request to: #{full_url}"
       response = JSON.parse(signed_request.execute)
       @config.logger.info "Signed request executed. Response: #{response}"
-      response
+      Representation.new(response)
     end
 
     private
@@ -25,12 +25,15 @@ module Loquor
     end
 
     def request
-      full_url = "#{@config.endpoint}#{@url}"
       RestClient::Request.new(url: full_url,
                               accept: :json,
                               payload: @payload.to_json,
                               headers: {'Content-type' => 'application/json'},
                               method: :post)
     end
+
+    def full_url
+      "#{@config.endpoint}#{@url}"
+    end
   end
 end

data/lib/loquor/interactor.rb

@@ -0,0 +1,29 @@
+module Loquor
+  module Interactor
+    module ClassMethods
+      [:find, :find_each, :where, :create].each do |proxy|
+        define_method proxy do |*args, &block|
+          new.send proxy, *args, &block
+        end
+      end
+    end
+
+    module InstanceMethods
+      def find(id)
+        ApiCall::Show.new(self.class.path, id).execute
+      end
+
+      def find_each(&block)
+        ApiCall::Index.new(self.class.path).find_each(&block)
+      end
+
+      def where(*args)
+        ApiCall::Index.new(self.class.path).where(*args)
+      end
+
+      def create(payload)
+        ApiCall::Create.new(self.class.path, payload).execute
+      end
+    end
+  end
+end

data/lib/loquor/{representations.rb → interactors.rb}

@@ -1,7 +1,7 @@
-Loquor::Representations.each do |name, path|
+Loquor::Interactors.each do |name, path|
   klass = Class.new(Object) do
-    extend Loquor::Representation::ClassMethods
-    include Loquor::Representation::InstanceMethods
+    extend Loquor::Interactor::ClassMethods
+    include Loquor::Interactor::InstanceMethods
 
     instance_eval <<-EOS
       def path

data/lib/loquor/representation.rb

@@ -1,29 +1,40 @@
 module Loquor
-  module Representation
-    module ClassMethods
-      [:find, :find_each, :where, :create].each do |proxy|
-        define_method proxy do |*args, &block|
-          new.send proxy, *args, &block
-        end
-      end
+  class Representation
+    def initialize(hash)
+      @hash = hash
     end
 
-    module InstanceMethods
-      def find(id)
-        ApiCall::Show.new(self.class.path, id).execute
+    def ==(other)
+      if other.is_a?(Representation)
+        @hash == other.get_instance_variable(:@hash)
+      elsif other.is_a?(Hash)
+        @hash == other
+      else
+        false
       end
+    end
 
-      def find_each(&block)
-        ApiCall::Index.new(self.class.path).find_each(&block)
-      end
+    def [](key)
+      @hash[key]
+    end
 
-      def where(*args)
-        ApiCall::Index.new(self.class.path).where(*args)
+    def method_missing(name, *args)
+      if @hash.has_key?(name)
+        @hash[name]
+      else
+        super
       end
+    end
+  end
+end
 
-      def create(payload)
-        ApiCall::Create.new(self.class.path, payload).execute
-      end
+class Hash
+  alias_method :hash_equals, :==
+  def ==(other)
+    if other.is_a?(Loquor::Representation)
+      other == self
+    else
+      hash_equals(other)
     end
   end
 end

data/lib/loquor/version.rb

@@ -1,3 +1,3 @@
 module Loquor
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/loquor.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'filum', '0.0.1'
+  spec.add_dependency 'filum', '0.0.2'
   spec.add_dependency 'rest-client', '1.6.7'
   spec.add_dependency "api-auth", "1.0.3"
 

data/test/api_calls/index_test.rb

@@ -93,5 +93,22 @@ module Loquor
       Loquor.expects(:get).with("http://foobar.com?&page=2&per=200").returns([])
       searcher.find_each {}
     end
+
+    def test_find_each_objects_are_representations
+      searcher = ApiCall::Index.new('')
+      Loquor.expects(:get).returns([{'id' => 8}, {'id' => 10}])
+      searcher.find_each do |rep|
+        assert rep.is_a?(Representation)
+      end
+    end
+
+    def test_objects_are_representations
+      index = ApiCall::Index.new("")
+      Loquor.stubs(get: [{foo: 'bar'}, {cat: 'dog'}])
+      results = index.send(:results)
+      assert results.is_a?(Array)
+      assert results[0].is_a?(Representation)
+      assert results[1].is_a?(Representation)
+    end
   end
 end

data/test/api_calls/show_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Loquor
+  class ApiCall::ShowTest < Minitest::Test
+
+    def test_response_is_a_representation
+      show = ApiCall::Show.new("", 1)
+      Loquor.stubs(get: {foo: 'bar'}.to_json)
+      response = show.execute
+      assert response.is_a?(Representation)
+    end
+  end
+end

data/test/http_actions/get_test.rb

@@ -38,5 +38,6 @@ module Loquor
       ApiAuth.expects(:sign!).with(request, @access_id, @secret_key)
       gets.send(:signed_request)
     end
+
   end
 end

data/test/http_actions/post_test.rb

@@ -46,6 +46,12 @@ module Loquor
       posts.send(:signed_request)
     end
 
+    def test_response_is_a_representation
+      posts = HttpAction::Post.new("", {}, deps)
+      posts.stubs(signed_request: mock(execute: {foo: 'bar'}.to_json))
+      response = posts.post
+      assert response.is_a?(Representation)
+    end
   end
 end
 

data/test/interactor_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Loquor
+  class InteractorTest < Minitest::Test
+    class FoobarInteractor
+      extend Interactor::ClassMethods
+      include Interactor::InstanceMethods
+
+      def self.path
+        "/foobar"
+      end
+    end
+
+    def test_find_should_get_correct_path_with_simple_path
+      id = 8
+      Loquor.expects(:get).with("/foobar/#{id}")
+      FoobarInteractor.find(id)
+    end
+
+    def test_find_each_should_get_correct_path
+      Loquor.expects(:get).with("/foobar?&page=1&per=200").returns([])
+      FoobarInteractor.find_each
+    end
+
+    def test_find_each_should_yield_block
+      Loquor.expects(:get).returns([{id: 1}])
+      ids = []
+      FoobarInteractor.find_each do |json|
+        ids << json['id']
+      end
+    end
+
+    def test_where_should_get_correct_path_with_simple_path
+      email = "foobar"
+      Loquor.expects(:get).with("/foobar?email=#{email}").returns([])
+      FoobarInteractor.where(email: email).to_a
+    end
+  end
+end

data/test/{representations_test.rb → interactors_test.rb}

@@ -1,7 +1,7 @@
 require File.expand_path('../test_helper', __FILE__)
 
 module Loquor
-  class RepresentationTest < Minitest::Test
+  class InteractorTest < Minitest::Test
 
     {
       MediaFile: "/media_files",

data/test/representation_test.rb

@@ -1,43 +1,15 @@
 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_find_each_should_get_correct_path
-      Loquor.expects(:get).with("/foobar?&page=1&per=200").returns([])
-      FoobarRepresentation.find_each
-    end
-
-    def test_find_each_should_yield_block
-      Loquor.expects(:get).returns([{id: 1}])
-      ids = []
-      FoobarRepresentation.find_each do |json|
-        ids << json['id']
-      end
+  class RepresenationTest < Minitest::Test
+    def test_is_accessible_as_a_hash
+      representation = Representation.new({foo: "bar"})
+      assert_equal "bar", representation[:foo]
     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
+    def test_hash_keys_are_accessible_via_methods
+      representation = Representation.new({foo: "bar"})
+      assert_equal "bar", representation.foo
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loquor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jeremy Walker
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENCE.md
@@ -131,18 +132,21 @@ files:
 - lib/loquor/http_action.rb
 - lib/loquor/http_actions/get.rb
 - lib/loquor/http_actions/post.rb
+- lib/loquor/interactor.rb
+- lib/loquor/interactors.rb
 - lib/loquor/representation.rb
-- lib/loquor/representations.rb
 - lib/loquor/version.rb
 - loquor.gemspec
 - test/api_calls/index_test.rb
+- test/api_calls/show_test.rb
 - test/client_test.rb
 - test/configuration_test.rb
 - test/http_action_test.rb
 - test/http_actions/get_test.rb
 - test/http_actions/post_test.rb
+- test/interactor_test.rb
+- test/interactors_test.rb
 - test/representation_test.rb
-- test/representations_test.rb
 - test/test_helper.rb
 homepage: https://www.meducation.net
 licenses:
@@ -170,12 +174,14 @@ specification_version: 4
 summary: This library dispatches requests to Meducation
 test_files:
 - test/api_calls/index_test.rb
+- test/api_calls/show_test.rb
 - test/client_test.rb
 - test/configuration_test.rb
 - test/http_action_test.rb
 - test/http_actions/get_test.rb
 - test/http_actions/post_test.rb
+- test/interactor_test.rb
+- test/interactors_test.rb
 - test/representation_test.rb
-- test/representations_test.rb
 - test/test_helper.rb
 has_rdoc: