loquor 0.0.1

data/README.md

@@ -0,0 +1,88 @@
+# Loquor
+
+[![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)
+[![Code Climate](https://codeclimate.com/github/meducation/loquor.png)](https://codeclimate.com/github/meducation/loquor)
+
+Handles calls to the Meducation API via an ActiveRecord-style interface
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'loquor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loquor
+
+
+## Usage
+
+You will want to set up some configuration variables.
+``` ruby
+Loquor.config do |config|
+  config.access_id  = "Username"
+  config.secret_key = "SecretKey1929292"
+  config.endpoint   = "http://www.meducation.net"
+end
+```
+
+Now you 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|
+  p "The user with id ##{user['id']} is #{user['name']}."
+end
+
+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"}
+```
+
+### Supported Objects
+
+The following are currently endpoints are supported:
+* Group Discussions
+* Group Discussion Posts
+* Media Files
+* Users
+
+### 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/loquor/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/loquor/blob/master/LICENCE.md)
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+namespace :test do
+  Rake::TestTask.new(:local) do |t|
+    t.pattern = "test/{components/,services/,helpers/,}*_test.rb"
+  end
+end
+
+task default: :test

data/lib/loquor.rb

@@ -0,0 +1,37 @@
+require 'rest-client'
+require 'api-auth'
+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
+  def self.config
+    if block_given?
+      yield loquor.config
+    else
+      loquor.config
+    end
+  end
+
+  def self.get(url)
+    loquor.get(url)
+  end
+
+  def self.post(url, payload)
+    loquor.post(url, payload)
+  end
+
+  private
+
+  def self.loquor
+    @loquor ||= Client.new
+  end
+end

data/lib/loquor/api_call.rb

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

data/lib/loquor/api_calls/index.rb

@@ -0,0 +1,46 @@
+module Loquor
+  class ApiCall::Index < ApiCall
+
+    attr_reader :criteria
+
+    def initialize(path)
+      super(path)
+      @criteria = {}
+    end
+
+    def where(value)
+      value.each do |key, value|
+        @criteria[key] = value
+      end
+      self
+    end
+
+    # Proxy everything to the results so that this this class
+    # transparently acts as an Array.
+    def method_missing(name, *args, &block)
+      results.send(name, *args, &block)
+    end
+
+    private
+
+    def results
+      if @results.nil?
+        @results = Loquor.get(generate_url)
+      end
+      @results
+    end
+
+    def generate_url
+      query_string = @criteria.map { |key,value|
+        if value.is_a?(String)
+          "#{key}=#{URI.encode(value)}"
+        elsif value.is_a?(Array)
+          "#{key}=[#{URI.encode(value.join(","))}]"
+        else
+          raise LoquorError.new("Filter values must be strings or arrays.")
+        end
+      }.join("&")
+      "#{build_path}?#{query_string}"
+    end
+  end
+end

data/lib/loquor/api_calls/show.rb

@@ -0,0 +1,13 @@
+module Loquor
+  class ApiCall::Show < ApiCall
+
+    def initialize(path, id)
+      super(path)
+      @id = id
+    end
+
+    def execute
+      Loquor.get("#{build_path}/#{@id}")
+    end
+  end
+end

data/lib/loquor/client.rb

@@ -0,0 +1,19 @@
+module Loquor
+  class Client
+    attr_reader :config
+
+    def initialize
+      @config = Configuration.new
+    end
+
+    def get(url)
+      deps = {config: @config}
+      HttpAction::Get.get(url, deps)
+    end
+
+    def post(url, payload)
+      deps = {config: @config}
+      HttpAction::Post.post(url, payload, deps)
+    end
+  end
+end

data/lib/loquor/configuration.rb

@@ -0,0 +1,36 @@
+module Loquor
+  class LoquorError < StandardError
+  end
+  class LoquorConfigurationError < LoquorError
+  end
+
+  class Configuration
+
+    SETTINGS = [
+      :logger, :access_id, :secret_key, :endpoint
+    ]
+
+    attr_writer *SETTINGS
+
+    def initialize
+      Filum.config do |config|
+        config.logfile = "./log/loquor.log"
+      end
+      logger = Filum.logger
+    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(LoquorConfigurationError.new("Configuration for #{setting} is not set"))
+    end
+  end
+end
+

data/lib/loquor/http_action.rb

@@ -0,0 +1,16 @@
+module Loquor
+  class HttpAction
+    def initialize(url, deps)
+      @url = url
+      @config = deps[:config]
+    end
+
+    def signed_request
+      ApiAuth.sign!(request, @config.access_id, @config.secret_key)
+    end
+  end
+end
+
+require 'loquor/http_actions/get'
+require 'loquor/http_actions/post'
+

data/lib/loquor/http_actions/get.rb

@@ -0,0 +1,22 @@
+module Loquor
+  class HttpAction::Get < HttpAction
+    def self.get(url, deps)
+      new(url, deps).get
+    end
+
+    def initialize(url, deps)
+      super
+    end
+
+    def get
+      JSON.parse(signed_request.execute)
+    end
+
+    private
+    def request
+      full_url = "#{@config.endpoint}#{@url}"
+      RestClient::Request.new(url: full_url, method: :get)
+    end
+  end
+end
+

data/lib/loquor/http_actions/post.rb

@@ -0,0 +1,33 @@
+module Loquor
+  class HttpAction::Post < HttpAction
+    def self.post(url, payload, deps)
+      new(url, payload, deps).post
+    end
+
+    def initialize(url, payload, deps)
+      super(url, deps)
+      @payload = payload
+    end
+
+    def post
+      JSON.parse(signed_request.execute)
+    end
+
+    private
+
+    def signed_request
+      signed_request = super
+      p signed_request # If you take this line out - it all breaks. Yeah...
+      signed_request
+    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
+  end
+end

data/lib/loquor/path_builder.rb

@@ -0,0 +1,44 @@
+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/lib/loquor/representation.rb

@@ -0,0 +1,22 @@
+module Loquor
+  module Representation
+    module ClassMethods
+
+      [:find, :where].each do |proxy|
+        define_method proxy do |*args|
+          new.send proxy, *args
+        end
+      end
+    end
+
+    module InstanceMethods
+      def find(id)
+        ApiCall::Show.new(self.class.path, id).execute
+      end
+
+      def where(*args)
+        ApiCall::Index.new(self.class.path).where(*args)
+      end
+    end
+  end
+end

data/lib/loquor/representations.rb

@@ -0,0 +1,28 @@
+{
+  "Group::Discussion"     => "/group/:group_id/discussions",
+  "Group::DiscussionPost" => "/group/:group_id/discussion",
+  "MediaFile"             => "/media_files",
+  "User"                  => "/users"
+}.each do |name, path|
+  klass = Class.new(Object) do
+    extend Loquor::Representation::ClassMethods
+    include Loquor::Representation::InstanceMethods
+
+    define_method :path do
+      path
+    end
+  end
+
+  # Split off the Group and Discussion parts
+  name_parts = name.split("::")
+  klass_name = name_parts.pop
+
+  # Create base modules
+  const = Loquor
+  name_parts.each do |name_part|
+    const.const_set name_part, Module unless const.const_defined?(name_part)
+  end
+
+  # Define the actual klass at the right point
+  const.const_set klass_name, klass
+end