nasreddin 0.3.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14b6167ede8abe24650d6a757cf8559cc8e2855f
+  data.tar.gz: cb9108d4eb76c807370a626c736ece44260892ac
+SHA512:
+  metadata.gz: 83bc41838bb86061abecba46b6d64f101d9135ce620f1d6fe05b22abaf713a571bc4707b2896f82436c1d128c11044394ffbb18250d0699ee9e5f573ef3dcb8a
+  data.tar.gz: 18314db0937c622bb89f01cd41e2d86b19a5830e386450b52bc2b867e81e50d95dd5dca6d6d875a3ea7f371cf156d0e56630ffabe0c4db79ad4cff7e575d05f5

data/README.md

@@ -0,0 +1,42 @@
+> "Nasreddin, your donkey has been lost."
+
+> "Thank goodness I was not on the donkey at the time, or I would be lost too."
+
+
+## What is Nasreddin?
+
+Nasreddin Hoca was a wise scolar from 13th century Anatolia. This, however, is a library designed to enable know-nothing
+distribution of data requests between varying services.
+
+To connect two services, one needs to include the Nasreddin::APIServer middleware and indicate what resources it is offering:
+```ruby
+require 'nasreddin/api-server'
+
+use Nasreddin::APIServer, resources: %w| users |
+run MyApp
+```
+Then, the consumer can use the Nasreddin::Resource class to generate new classes that will talk to the APIServer when making
+requests.
+
+
+An example implementation of Nasreddin::Resource is provided below
+
+```ruby
+require 'nasreddin/resource'
+
+class User < Nasreddin::Resource('users') # name of endpoint for resource
+end
+
+```
+
+
+## Caveats
+
+Currently, Nasreddin relies on JRuby and TorqueBox/HornetQ.
+
+
+## License
+
+Copyright (C) 2012-2013 Burnside Digital
+
+Licensed under the BSD 2-Clause License. See COPYING for license details.

data/lib/nasreddin.rb

@@ -0,0 +1,4 @@
+require 'nasreddin/version'
+require 'nasreddin/resource'
+require 'nasreddin/remote_torquebox_adapter'
+require 'nasreddin/api-server'

data/lib/nasreddin/api-server.rb

@@ -0,0 +1,136 @@
+require 'stringio'
+require 'uri'
+
+module Nasreddin
+
+  class APIServer
+
+    def initialize(app, options = {})
+      @app = app
+      @threads = {}
+      @resources = options[:resources]
+      @route_prefix = options[:route_prefix]
+      if @resources
+        @resources.each do |resource|
+          @threads[resource] = Thread.new { Nasreddin::APIServerResource.new(@route_prefix,resource,@app).run }
+        end
+      else
+        $stderr.puts "WARNING: Nasreddin::APIServer is being used without any resources specified!"
+      end
+    end
+
+    def call(env)
+      params = Rack::Request.new(env).params
+
+      if is_heartbeat?(params)
+          res = params['resource'] = params['resources'].pop
+          params["resources.#{res}"] = @resources
+          Nasreddin::Resource(@resource).remote_call(params)
+      else
+        @app.call(env)
+      end
+    end
+
+    def is_heartbeat?(params)
+      params.has_key? '__hearbeat__'
+    end
+  end
+
+  class APIServerResource 
+
+    DEFAULT_ENV = {
+        'rack.errors'       => $stderr,
+        'rack.input'        => StringIO.new,
+        'rack.version'      => [1, 1],
+        'rack.multithread'  => true,
+        'rack.multiprocess' => true,
+        'rack.run_once'     => false,
+        'HTTP_ACCEPT'       => 'application/json',
+        'HTTP_USER_AGENT'   => 'NasreddinAPI'
+    }
+
+    def initialize(route_prefix,resource,app)
+      @resource = resource
+      @route_prefix = route_prefix
+      @app = app
+    end
+
+    def queue
+      @queue ||= TorqueBox::Messaging::Queue.start("/queues/#{@resource}", durable: false)
+    end
+
+    def run
+      loop do
+        begin
+          queue.receive_and_publish &method(:process_incoming_message)
+        rescue Exception => err
+          $stderr.puts "Error processing request: #{err.class} - #{err.message}"
+          if err.kind_of?(Java::JavaxJms::JMSException)
+            break
+          end
+        end
+      end
+      queue.stop
+    end
+
+    def is_heartbeat?(msg)
+        msg[:params] && msg[:params].has_key?('__heartbeat__')
+    end
+
+    def call(env)
+        @app.call(env)
+    end
+
+    def process_incoming_message(msg)
+        return heartbeat_ok  if is_heartbeat?(msg)
+
+        begin
+          status, headers, body = call(env(msg))
+
+          resp = ''
+          body.each { |d| resp += d.to_s }
+          body.close if body.respond_to?(:close)
+
+        rescue Exception => err
+          resp = "#{err.message}\n\n#{err.backtrace.join("\n")}"
+        end
+
+        [status, headers, resp]
+    end
+
+    def heartbeat_ok
+        [200, nil, "OK"]
+    end
+
+    def env(msg)
+      env = DEFAULT_ENV.clone
+      env['rack.url_scheme'] = (msg.delete(:secure) ? 'https' : 'http')
+      method = msg.delete(:method) || 'GET'
+      env['REQUEST_METHOD'] = method.to_s.upcase
+      env['QUERY_STRING'] = queryize(msg.delete(:params)) || ''
+      env['SCRIPT_NAME'] = "/#{@route_prefix}" || ''
+      env['PATH_INFO'] = "/#{@resource}"
+      if ((id = msg.delete(:id)))
+        env['PATH_INFO'] += "/#{id}"
+      end
+      if ((path = msg.delete(:path)))
+        env['PATH_INFO'] += "/#{path}"
+      end
+      env['REQUEST_URI'] = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+      env.merge!(Hash[msg.map { |k, v| [k.to_s, v] }])
+      env
+    end
+
+    private
+
+    def queryize(params = {})
+      params.map do |key, value|
+        if value.is_a? Array
+          value.map { |v| URI.encode("#{key}[]=#{v}") }
+        else
+          URI.encode("#{key}=#{value}")
+        end
+      end.join('&') unless params.nil?
+    end
+  end
+end

data/lib/nasreddin/remote_torquebox_adapter.rb

@@ -0,0 +1,38 @@
+#require 'torquebox/messaging'
+require 'multi_json'
+
+module Nasreddin
+  class RemoteTorqueboxAdapter
+    attr_accessor :resource, :klass
+
+    def load_data(data,resource, as_objects = true)
+      resp = MultiJson.load(data)
+      resp = resp[@resource] if resp.respond_to?(:keys) && resp.keys.include?(@resource)
+      if resp.kind_of? Array
+        as_objects ? resp.map { |r| @klass.new(r) } : resp
+      else
+        as_objects ? @klass.new(resp) : resp
+      end
+    end
+
+    def succeded?(status)
+      status != nil && status > 199 && status < 300
+    end
+
+    def queue
+      @queue ||= TorqueBox::Messaging::Queue.start("/queues/#{@resource}", durable: false)
+    end
+
+    def call(params, as_new_objects=false)
+      status, _, data = *(queue.publish_and_receive(params, persistant: false))
+      values = load_data(data,@resource,as_new_objects) if data && !data.empty?
+      [ succeded?(status), values ]
+    end
+
+    def initialize(resource, klass)
+      @resource = resource
+      @klass = klass
+    end
+  end
+
+end

data/lib/nasreddin/resource.rb

@@ -0,0 +1,175 @@
+require 'torquebox/messaging'
+require 'multi_json'
+
+module Nasreddin
+
+  class SaveError < Exception ; end
+
+  # == Nasreddin Resource
+  # Provides a base class for implementing an API backed data object.
+  # A minimal implementation could be:
+  #   class Car < Nasreddin::Resource('cars')
+  #   end
+  class Resource
+    class<<self
+      attr_accessor :resource
+
+      def subclasses; (@subclasses ||= []); end
+
+      def inherited(sub)
+        subclasses << sub
+        sub.resource = @resource
+      end
+
+      def remote
+        @remote ||= Nasreddin::RemoteTorqueboxAdapter.new(@resource, self)
+      end
+
+      def remote_call(params = {}, as_objects=true)
+        success, values = remote.call(params, as_objects)
+        values
+      end
+
+      # Allows fetching of all entities without requiring filtering
+      # parameters.
+      def all
+        remote_call({ method: 'GET' }, true)
+      end
+
+      # Allows searching for a specific entity or a collection of
+      # entities that match a certain criteria.
+      # example usage:
+      #   Car.find(15)
+      #   # => #<Car:0x5fafa486>
+      #
+      #   Car.find(make: 'Ford')
+      #   # => [ #<Car:0x5fafa486> ]
+      #
+      #   Car.find(15, make: 'Ford')
+      #   # => [ #<Car:0x5fafa486> ]
+      def find(*args)
+        params = args.last.kind_of?(Hash) ? args.pop : {}
+        id = args.shift
+
+        remote_call({ method: 'GET', id: id, params: params })
+      end
+
+      # Allows creating a new record in one shot
+      # returns true if the record was created
+      # example usage:
+      #   Car.create make: 'Ford', model: 'Focus'
+      #   # => true or false
+      def create(properties = {})
+        new(properties).save
+      end
+
+      # Allows destroying a resource without finding it
+      # example usage:
+      # Car.destroy(15)
+      # # => true or false
+      def destroy(id)
+        remote_call({ method: 'DELETE', id: id }, false).empty?
+      end
+    end
+
+    # Custom to_json implementation
+    # passes through options to @data
+    def to_json(options={})
+      @data.to_json(options)
+    end
+
+    # Custom as_json implementation
+    # passes through options to @data
+    def as_json(options={})
+      @data.as_json(options)
+    end
+
+    # Checks if the current instance has
+    # already been deleted
+    def deleted?
+      @deleted
+    end
+
+    # Saves the current resource instance
+    # if the instance has an ID it sends a PUT request
+    # otherwise it sends a POST request
+    # will raise an error if the object has been deleted
+    # example usage:
+    #   car = Car.find(15)
+    #   car.miles += 1500
+    #   car.save
+    #   # => true or false
+    def save
+      raise SaveError.new("Cannot save a deleted resource") if deleted?
+
+      if @data['id'].to_s.empty?
+       remote_call({ method: 'POST', params: @data })
+      else
+       remote_call({ method: 'PUT', id: @data['id'], params: @data })
+      end
+    end
+
+    def remote_call(params)
+      success, values = remote.call(params, false)
+      @data = values if values && !values.empty?
+      success
+    end
+
+    # Destroys the current resource instance
+    # example usage:
+    # car = Car.find(15)
+    # car.destroy
+    # # => true or false
+    def destroy
+      if !deleted?
+        @deleted = remote_call({ method: 'DELETE', id: @data['id'] })
+      end
+    end
+
+    # Initialize a new instance
+    # also defines setters for any values given
+    # example usage:
+    #   car = Car.new make: 'Ford', model: 'Mustang'
+    #   car.respond_to? :make=
+    #   # => true
+    def initialize(data={})
+      @deleted = false
+      @data = data
+      @data.each do |key, value|
+        unless respond_to?("#{key.to_s}=")
+          self.class.send(:define_method, "#{key.to_s}=") do |other|
+            @data[key.to_s] = other
+          end
+        end
+      end
+    end
+
+    def method_missing(mid, *args, &block)
+      if @data.keys.include?(mid.to_s)
+        @data[mid.to_s]
+      else
+        super
+      end
+    end
+
+    def respond_to?(mid, include_private=false)
+      @data.keys.include?(mid.to_s) || super
+    end
+
+    private
+
+    def remote
+      self.class.send(:remote)
+    end
+
+  end
+
+  def self.Resource(name)
+    klass = Resource.subclasses.find { |k| k.resource == name }
+    unless klass
+      klass = Class.new(Resource)
+      klass.resource = name
+    end
+    klass
+  end
+end

data/lib/nasreddin/version.rb

@@ -0,0 +1,3 @@
+module Nasreddin
+  VERSION = '0.3.10'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: nasreddin
+version: !ruby/object:Gem::Version
+  version: 0.3.10
+platform: ruby
+authors:
+- Josh Ballanco
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: torquebox
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: torquebox-server
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: yard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: bacon
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: mocha-on-bacon
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: ' Nasreddin is a library to make distributed calls via HornetQ '
+email:
+- jballanc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/nasreddin.rb
+- ./lib/nasreddin/api-server.rb
+- ./lib/nasreddin/remote_torquebox_adapter.rb
+- ./lib/nasreddin/resource.rb
+- ./lib/nasreddin/version.rb
+- README.md
+homepage: ''
+licenses: []
+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.10
+signing_key:
+specification_version: 4
+summary: A library for making distributed calls via HornetQ
+test_files: []
+has_rdoc: