loquor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937168fc0385f2a0842aa6d6a6dcacd2d9ea529d
-  data.tar.gz: 6c1be377cbe87ac489c55b936b4ba89ef71c60b9
+  metadata.gz: 070654de10baeadaf8cdb835f456d178456077c0
+  data.tar.gz: 0d3e50f2eabba9f9aa1e16f5b4cf56fe14cb5afe
 SHA512:
-  metadata.gz: 6c067e8417007a642691acaa979ec7b26ecb77f2f77037e03ebd18b78ba2cc979a27b366e35c2299133d8ab373df7927093942dba961cfa487229b0025372375
-  data.tar.gz: 807ed1e17a3931d46b864b32de2d4b18badc6d82fbdcab05750566d00ab1c948d6c73a680a82978d895c62bd18349b1933e91340898cabdf01dbf3aeb7249982
+  metadata.gz: 8a5ced6b3668a0ad27d4c00c3c7294737b593e909a3663b147565d2b628b0528912d385705a00e8419440b1f3c0b10953f0c95fec583e5d8375ec8e464ea8bbf
+  data.tar.gz: 74d3922223e408c2a89cc5134593df7cfc2316a83d6873f968392e8a26fda795a73b15aaf3b12b6ecf21abc8d42ac3ff789c3b9556c33d1fdec79c7744635d85

data/README.md

@@ -1,4 +1,4 @@
-# Loquor
+# Loquor - Meducation API Dispatcher
 
 [![Build Status](https://travis-ci.org/meducation/loquor.png)](https://travis-ci.org/meducation/loquor)
 [![Dependencies](https://gemnasium.com/meducation/loquor.png?travis)](https://gemnasium.com/meducation/loquor)
@@ -10,16 +10,14 @@ Handles calls to the Meducation API via an ActiveRecord-style interface
 
 Add this line to your application's Gemfile:
 
-    gem 'loquor'
+```ruby
+gem 'loquor'
+```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install loquor
-
 
 ## Usage
 
@@ -32,16 +30,16 @@ Loquor.config do |config|
 end
 ```
 
-Now you make requests to get, create, update, destroy and list a range of objects, like this:
+Now you can make requests to get, create, update, destroy and list a range of objects, like this:
 
 ```ruby
-User.where(email: "jeremy@meducation.net").where(name: "Jeremy").each do |user|
+Loquor::User.where(email: "jeremy@meducation.net").where(name: "Jeremy").each do |user|
   p "The user with id ##{user['id']} is #{user['name']}."
 end
 
-User.find(2) # => {id: 2, name: "Jeremy Walker"}
+Loquor::User.find(2) # => {id: 2, name: "Jeremy Walker"}
 
-User.create(name: "Jeremy Walker", email: "jeremy@meducation.net") # => {id: 2, name: "Jeremy Walker", email "jeremy@meducation.net"}
+Loquor::User.create(name: "Jeremy Walker", email: "jeremy@meducation.net") # => {id: 2, name: "Jeremy Walker", email "jeremy@meducation.net"}
 ```
 
 ### Supported Objects

data/lib/loquor.rb

@@ -5,14 +5,20 @@ require 'filum'
 require "loquor/version"
 require "loquor/configuration"
 require "loquor/client"
-require 'loquor/path_builder'
 require 'loquor/representation'
-require 'loquor/representations'
 
 require 'loquor/api_call'
 require "loquor/http_action"
 
 module Loquor
+
+  Representations = {
+    "GroupDiscussion"     => "/group_discussions",
+    "GroupDiscussionPost" => "/group_discussion_posts",
+    "MediaFile"           => "/media_files",
+    "User"                => "/users"
+  }
+
   def self.config
     if block_given?
       yield loquor.config
@@ -35,3 +41,5 @@ module Loquor
     @loquor ||= Client.new
   end
 end
+
+require 'loquor/representations'

data/lib/loquor/api_call.rb

@@ -1,11 +1,11 @@
 module Loquor
   class ApiCall
-    include Loquor::PathBuilder
     def initialize(path)
-      setup_path_builder(path)
+      @path = path
     end
   end
 end
 
+require 'loquor/api_calls/create'
 require 'loquor/api_calls/show'
 require 'loquor/api_calls/index'

data/lib/loquor/api_calls/create.rb

@@ -0,0 +1,14 @@
+module Loquor
+  class ApiCall::Create < ApiCall
+
+    def initialize(path, payload)
+      super(path)
+      @payload = payload
+    end
+
+    def execute
+      Loquor.post(@path, @payload)
+    end
+  end
+end
+

data/lib/loquor/api_calls/index.rb

@@ -40,7 +40,7 @@ module Loquor
           raise LoquorError.new("Filter values must be strings or arrays.")
         end
       }.join("&")
-      "#{build_path}?#{query_string}"
+      "#{@path}?#{query_string}"
     end
   end
 end

data/lib/loquor/api_calls/show.rb

@@ -7,7 +7,7 @@ module Loquor
     end
 
     def execute
-      Loquor.get("#{build_path}/#{@id}")
+      Loquor.get("#{@path}/#{@id}")
     end
   end
 end

data/lib/loquor/http_action.rb

@@ -6,6 +6,7 @@ module Loquor
     end
 
     def signed_request
+      @config.logger.info "Signing request."
       ApiAuth.sign!(request, @config.access_id, @config.secret_key)
     end
   end

data/lib/loquor/http_actions/get.rb

@@ -9,7 +9,10 @@ module Loquor
     end
 
     def get
-      JSON.parse(signed_request.execute)
+      @config.logger.info "Making GET request to: #{@url}"
+      response = JSON.parse(signed_request.execute)
+      @config.logger.info "Signed request executed. Response: #{response}"
+      response
     end
 
     private
@@ -19,4 +22,3 @@ module Loquor
     end
   end
 end
-

data/lib/loquor/http_actions/post.rb

@@ -10,7 +10,10 @@ module Loquor
     end
 
     def post
-      JSON.parse(signed_request.execute)
+      @config.logger.info "Making POST request to: #{@url}"
+      response = JSON.parse(signed_request.execute)
+      @config.logger.info "Signed request executed. Response: #{response}"
+      response
     end
 
     private

data/lib/loquor/representation.rb

@@ -1,8 +1,7 @@
 module Loquor
   module Representation
     module ClassMethods
-
-      [:find, :where].each do |proxy|
+      [:find, :where, :create].each do |proxy|
         define_method proxy do |*args|
           new.send proxy, *args
         end
@@ -17,6 +16,10 @@ module Loquor
       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

@@ -1,16 +1,13 @@
-{
-  "Group::Discussion"     => "/group/:group_id/discussions",
-  "Group::DiscussionPost" => "/group/:group_id/discussion",
-  "MediaFile"             => "/media_files",
-  "User"                  => "/users"
-}.each do |name, path|
+Loquor::Representations.each do |name, path|
   klass = Class.new(Object) do
     extend Loquor::Representation::ClassMethods
     include Loquor::Representation::InstanceMethods
 
-    define_method :path do
-      path
-    end
+    instance_eval <<-EOS
+      def path
+        "#{path}"
+      end
+    EOS
   end
 
   # Split off the Group and Discussion parts

data/lib/loquor/version.rb

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

data/test/http_action_test.rb

@@ -0,0 +1,22 @@
+module Loquor
+ class HttpAction::Test < Minitest::Test
+    def setup 
+      super 
+      @access_id = "123"
+      @secret_key = "Foobar132"
+      @endpoint = "http://www.thefoobar.com"
+    end
+
+    def deps
+      logger = mock()
+      logger.stubs(info: nil)
+
+      config = mock()
+      config.stubs(logger: logger)
+      config.stubs(access_id: @access_id)
+      config.stubs(secret_key: @secret_key)
+      config.stubs(endpoint: @endpoint)
+      {config: config}
+    end
+ end
+end

data/test/http_actions/get_test.rb

@@ -1,7 +1,8 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 module Loquor
-  class HttpAction::GetTest < Minitest::Test
+  class HttpAction::GetTest < HttpAction::Test
+
     def test_get_should_call_new
       url = "foobar"
       deps = {x: true}
@@ -17,32 +18,24 @@ module Loquor
     def test_get_parses_request
       output = {'foo' => 'bar'}
       json = output.to_json
-      gets = HttpAction::Get.new("", {})
+
+      gets = HttpAction::Get.new("", deps)
       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}
-
+      full_url = "#{@endpoint}#{url}"
       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)
+      ApiAuth.expects(:sign!).with(request, @access_id, @secret_key)
       gets.send(:signed_request)
     end
   end

data/test/http_actions/post_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 module Loquor
-  class HttpAction::PostTest < Minitest::Test
+  class HttpAction::PostTest < HttpAction::Test
     def test_post_should_call_new
       url = "foobar"
       payload = {y: false}
@@ -26,10 +26,7 @@ module Loquor
     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}
+      full_url = "#{@endpoint}#{url}"
 
       RestClient::Request.expects(:new).with(
         url: full_url,
@@ -42,15 +39,10 @@ module Loquor
     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)
+      ApiAuth.expects(:sign!).with(request, @access_id, @secret_key)
       posts.send(:signed_request)
     end
 

data/test/representations_test.rb

@@ -6,10 +6,16 @@ module Loquor
     {
       MediaFile: "/media_files",
       User: "/users"
+      GroupDiscussion: "/group_discussions"
+      GroupDiscussionPost: "/group_discussion_posts"
     }.each do |klass, path|
       define_method "test_#{klass}_set_up_correctly" do
         assert Loquor.const_defined?(klass)
       end
+
+      define_method "test_#{klass}_stores_path_up_correctly" do
+        assert_equal path, Loquor.const_get(klass).path
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loquor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Walker
@@ -123,6 +123,7 @@ files:
 - Rakefile
 - lib/loquor.rb
 - lib/loquor/api_call.rb
+- lib/loquor/api_calls/create.rb
 - lib/loquor/api_calls/index.rb
 - lib/loquor/api_calls/show.rb
 - lib/loquor/client.rb
@@ -130,7 +131,6 @@ files:
 - 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
@@ -138,9 +138,9 @@ files:
 - test/api_calls/index_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/path_builder_test.rb
 - test/representation_test.rb
 - test/representations_test.rb
 - test/test_helper.rb
@@ -172,9 +172,9 @@ test_files:
 - test/api_calls/index_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/path_builder_test.rb
 - test/representation_test.rb
 - test/representations_test.rb
 - test/test_helper.rb

data/lib/loquor/path_builder.rb

@@ -1,44 +0,0 @@
-module Loquor
-
-  class MissingUrlComponentError < LoquorError
-    def initialize(url_component)
-      @url_component = url_component
-    end
-
-    def message
-      "#{url_component} has not been set. Use Object.for_#{url_component}"
-    end
-  end
-
-  module PathBuilder
-    PATH_PART_REGEX = /:[a-z0-9_]+/
-
-    def setup_path_builder(path)
-      path.split('/').each do |path_part|
-        next unless path_part =~ PATH_PART_REGEX
-        path_part = path_part[1..-1]
-        method_name = "for_#{path_part}"
-
-        self.class.send :define_method, method_name do |id|
-          @path_parts ||= {}
-          @path_parts[path_part.to_sym] = id
-          self
-        end
-
-        self.class.class_eval <<-EOS
-          def self.#{method_name}(*args)
-            new.#{method_name}(*args)
-          end
-        EOS
-      end
-
-      self.class.send :define_method, :build_path do
-        path.gsub(PATH_PART_REGEX) do |path_part|
-          path_part = path_part[1..-1].to_sym
-          @path_parts ||= {}
-          @path_parts.fetch(path_part) { raise MissingUrlComponentError.new(path_part) }
-        end
-      end
-    end
-  end
-end

data/test/path_builder_test.rb

@@ -1,46 +0,0 @@
-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
-