stargate 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f25956089ca512458f7c638f448eaca0eb549f9
-  data.tar.gz: 8d66b7d3f3b0ea725559cdff2ec898a2b9ca6cfe
+  metadata.gz: 5bd3b300a1db02cdc5888f43fcbb12898f39e757
+  data.tar.gz: aa03a1e5779f1b3d8bf6baa089a04008d13ab975
 SHA512:
-  metadata.gz: 19179b263299e1fa3ea5d9244814df8a1dd879bd1b88a3a58513f4a7c42a4af94022c70bafedebb8f523c432b7df81fc9f8164a6b77fe401652889c1e13e5578
-  data.tar.gz: 2c4174d187433886b768a2487aa4ec25735e06b461391d330b9b2e0b529ef1cb7136c5cd4023507998b56c0a090d104b3d5101d8a97394cbd12664164bbf003e
+  metadata.gz: 81aa058faf53aff8833a8151889e2f54cbab0c995f63c7064737e5d1e2911c4be64f287d1f9cb48608020460d95809a62b38d3ef481d186307b0e29048400ccd
+  data.tar.gz: 826bfb7249126d66fe8b4d87189c96a68758288ca4ee0a30968b7da1e7554fe4257de534f417064b88077d171eafcda84a199b22bbfa92ccd73776b23bfd2009

data/CHANGELOG.md

@@ -6,6 +6,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ...
 
+## [0.1.3]
+
+...
+
 ## [0.1.2]
 
 ### Fixed

data/README.md

@@ -1,6 +1,8 @@
 # Stargate
 
-[![Status](https://codeship.com/projects/XXX/status?branch=master)](https://codeship.com/projects/XXX)
+[![Codeship Status for jobandtalent/stargate](https://codeship.com/projects/7bd04ac0-a02a-0133-8adf-6af23f5d89a3/status?branch=master)](https://codeship.com/projects/128080)
+
+![Stargate](http://i.imgur.com/NTASGkO.jpg)
 
 Stargate is a portal between ruby (and in the future not any) apps. It facilitates creating internal micro-services
 and allows to scale your logic pretty much infinitely.
@@ -34,7 +36,7 @@ class are executed locally or remotely. Fire, get results, forget. No thinking o
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'stargate', '0.1.2'
+gem 'stargate', '0.1.3'
 ```
 
 And then execute:
@@ -43,7 +45,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install stargate --version 0.1.2
+    $ gem install stargate --version 0.1.3
 
 ## Usage
 

data/examples/server/config.ru

@@ -1,5 +1,3 @@
-require 'stargate/server/engine/sinatra'
-
 module NightsWatch
   class NewBrother
     def self.oath
@@ -28,6 +26,9 @@ module NightsWatch
   end
 end
 
+require 'stargate'
+require 'stargate/server/engine/sinatra'
+
 registry = Stargate::Server::Registry.new do
   version 1 do
     serve NightsWatch::NewBrother do

data/lib/stargate/client/core_ext/kernel.rb

@@ -1,8 +1,16 @@
 module Kernel
+  # Public: Loads remote definitions from given URL and injects them in local namespace.
+  #
+  # Example:
+  #
+  #   require_remote('http+json://example.com/v1#timeout=0.3')
+  #
+  # Returns nothing.
   def require_remote(url)
     @required_remotes ||= []
     return if @required_remotes.include?(url)
     injector = Stargate::Client::Injector.new(url)
     @required_remotes << url
+    nil
   end
 end

data/lib/stargate/client/injector.rb

@@ -1,5 +1,7 @@
 module Stargate
   module Client
+    # Internal: The job of Injector is to inject remote definitions to local namespace. It does it by
+    # creating new namespaces dynamically and injecting Proxy classes to remote objects.
     class Injector
       include Logging
       include Stargate::Client

data/lib/stargate/client/protocol.rb

@@ -10,23 +10,37 @@ module Stargate
 
       @@transports = {}
 
+      # Public: List of registered transports (protocol implementations).
       def self.transports
         @@transports
       end
 
+      # Public: Registers new implementation for given protocols.
       def self.register(protocols, transport)
         protocols.each { |protocol| transports[protocol] = transport }
       end
 
+      # Public: Finds implementation for given protocol.
+      #
+      # Returns transport if found.
+      # Raises UnsupportedProtocolError if not found.
       def self.[](protocol)
         transports[protocol.downcase] or raise UnsupportedProtocolError, "Unsupported protocol: #{protocol}"
       end
 
+      # Public: Codec used to serialize/deserialize payload.
       attr_reader :codec
+
+      # Public: Remote URL of the endpoint.
       attr_reader :uri
+
+      # Public: URL without credentials part.
       attr_reader :safe_uri
+
+      # Public: Transport configuration.
       attr_reader :options
 
+      # Public: Constructor.
       def initialize(codec, uri)
         @codec        = codec
         @uri          = uri
@@ -35,10 +49,12 @@ module Stargate
         @unmarshaller = Unmarshaller.new
       end
 
+      # Public: Shall load all definitions from remote server.
       def fetch_definitions
         raise NotImplementedError
       end
 
+      # Public: Shall execute class method with given arguments. Executes method remotely of course.
       def call(klass, method, *args)
         raise NotImplementedError
       end
@@ -49,14 +65,19 @@ module Stargate
         { timeout: DEFAULT_TIMEOUT }
       end
 
+      # Internal: A helper to unpack loaded data.
       def unpack_payload(data)
         @unmarshaller.unmarshal(data)
       end
 
+      # Internal: A helper to unpack remote definitions.
       def unpack_definitions(definitions)
         definitions.map { |metadata| ::Stargate::Metadata.from_hash(metadata) }
       end
 
+      # Internal: Parses options from URI fragment. Example http+json://example.com/v1#timeout=0.3
+      #
+      # Returns hash with options.
       def parse_options_from_uri_fragment
         uri.fragment.to_s.split(';').inject({}) do |options, entry|
           k, v = entry.split('=')

data/lib/stargate/client/protocol/http.rb

@@ -2,6 +2,7 @@ require 'rest-client'
 
 module Stargate
   module Client
+    # Internal:: HTTP protocol implementation based on Sinatra engine implemented on the Server side.
     class Protocol::HTTP < Protocol
       def fetch_definitions
         log.debug("Loading remote definitions", url: safe_uri.to_s)

data/lib/stargate/client/protocol/inproc.rb

@@ -2,6 +2,7 @@ require 'rest-client'
 
 module Stargate
   module Client
+    # Internal: A client implementation compatible with Inproc server engine.
     class Protocol::Inproc < Protocol
       RegistryNotFoundError = Class.new(::Stargate::Client::Error)
 

data/lib/stargate/client/proxy.rb

@@ -1,10 +1,17 @@
 module Stargate
   module Client
+    # Internal: Here's where the magic happens. The proxy class connects local method calls with
+    # remote endpoints. Basically whenever any of registered (provided by remote definitions) methods
+    # is called, proxy forwards this call to remote location and returns obtained results adapted
+    # to local context.
     class Proxy
+      # Internal: Magic for metaprogramming tricks.
       def self.metaclass
         class << self; self; end
       end
 
+      # Internal: Configures portal for given protocol. Takes class metadata to define all entry
+      # point class methods, object attributes and readers.
       def self.configure_stargate_portal(protocol, metadata)
         metaclass.instance_eval do
           metadata.class_methods.each do |method|
@@ -22,10 +29,12 @@ module Stargate
         define_readers(*metadata.readers)
       end
 
+      # Internal: Helper to define all attributres (accessors).
       def self.define_attributes(*names)
-        names.each { |name| attr_accessor(name) }
+        attr_accessor(*names)
       end
 
+      # Internal: Helper to define reader methods.
       def self.define_readers(*names)
         names.each do |name|
           name = name.to_s
@@ -35,6 +44,9 @@ module Stargate
         end
       end
 
+      # Public: Constructor. Proxy class ignores remote constructor definition. Local proxy is always
+      # treaded as a data structure only and thus it's convenient to initialize it with attributes
+      # to set.
       def initialize(attributes = {})
         attributes.each do |name,value|
           instance_variable_set("@#{name}", value)

data/lib/stargate/codec.rb

@@ -11,18 +11,22 @@ module Stargate
 
     @@codecs = {}
 
+    # Internal: Returns all registered codecs.
     def self.codecs
       @@codecs
     end
 
+    # Public: Register new codec.
     def self.register(codec)
       codecs[codec.content_type.to_s] = codec
     end
 
+    # Public: Find codec by given identifier.
     def self.find_by_id(id)
       codecs.values.find { |codec| codec.id == id.to_sym } or raise UndefinedCodecError, "No such codec: #{id}"
     end
 
+    # Public: Find codec for given content type.
     def self.[](content_type)
       codecs[content_type.to_s] or raise UndefinedCodecError, "No codec for type: #{content_type}"
     end

data/lib/stargate/metadata.rb

@@ -1,7 +1,16 @@
 module Stargate
+  # Internal: We need a way to store information about registered classes. Each served class
+  # defines itself with the following information:
+  #
+  # * Class name (eventually serving alias)
+  # * List of exposed class methods
+  # * List of instance attributes (accessors)
+  # * List of instance methods (cacheable reader methods)
+  #
   class Metadata
     include Serialization
 
+    # Internal: Loads metadata information from hash.
     def self.from_hash(hash)
       hash.symbolize_keys!
 
@@ -12,10 +21,10 @@ module Stargate
       end
     end
 
-    attr_reader :klass
-
-    attr_reader :name
+    # The class to be served and it's serving alias.
+    attr_reader :klass, :name
 
+    # Public: Constructor.
     def initialize(klass, name, &block)
       @klass, @name = klass, name
       @class_methods = []
@@ -25,10 +34,6 @@ module Stargate
       instance_eval(&block) if block_given?
     end
 
-    def active_record?
-      @active_record
-    end
-
     def class_methods(*names)
       load_or_add(:class_methods, *names)
     end
@@ -56,10 +61,7 @@ module Stargate
 
     private
 
-    def klass_is_an_active_record?
-      defined?(::ActiveRecord) && klass && klass < ::ActiveRecord::Base
-    end
-
+    # Internal: A helper to define single access methods (getter/setter DSL methods).
     def load_or_add(method, *args)
       value = instance_variable_get("@#{method}")
       args.empty? ? value : value.concat(args.flatten.map(&:to_sym))

data/lib/stargate/server/caller.rb

@@ -1,5 +1,7 @@
 module Stargate
   module Server
+    # Internal: We need a way to call registered stuff. This little service handles it. Caller is
+    # defined per registry version and operates only within its context.
     class Caller
       include Logging
       include Stargate::Marshal

data/lib/stargate/server/engine/inproc.rb

@@ -3,6 +3,7 @@ require 'stargate/server'
 module Stargate
   module Server
     module Engine
+      # Public: Testing, in-process (more accurately in-app) engine to interchange information.
       class Inproc
         def self.register(name, registry)
           registry.each do |version_number, actual_registry|

data/lib/stargate/server/engine/sinatra.rb

@@ -3,6 +3,8 @@ require 'stargate/server'
 module Stargate
   module Server
     module Engine
+      # Public: Sinatra transport. Very simple implementation of a transport that speaks non-REST interface.
+      # Sorta RPC transport over HTTP implemented with Sinatra. 
       class Sinatra
         include Logging
 

data/lib/stargate/server/registry.rb

@@ -1,19 +1,36 @@
 module Stargate
   module Server
+    # Internal: Registry contains list of versions, each with defined served classes.
+    #
+    # Example:
+    #
+    #   Stargate::Server::Registry.new do
+    #     version 1 do
+    #       serve MyClass do
+    #         class_methods :foo, :bar
+    #         attributes :foo, :bar, :baz
+    #       end
+    #     end
+    #   end
+    #
     class Registry
       include Enumerable
 
+      # Public: List of registry versions.
       attr_reader :versions
 
+      # Public: Constructor.
       def initialize(&block)
         @versions = {}
         instance_eval(&block) if block_given?
       end
 
+      # Public: Defines new version. Executes with internal DSL.
       def version(number, &block)
         @versions[number] ||= RegistryVersion.new(number, &block)
       end
 
+      # Public: Returns given registry version.
       def [](version)
         versions[version] or raise RegistryVersionUndefinedError, "No such registry version: #{version}"
       end

data/lib/stargate/server/registry_version.rb

@@ -2,15 +2,20 @@ require 'forwardable'
 
 module Stargate
   module Server
+    # Internal: Here's where all information about served classes are stored. Registered classes information
+    # is stored in form of Stargate::Metadata.
     class RegistryVersion
       include Logging
       include Enumerable
       include Serialization
 
+      # Public: Registry version number.
       attr_reader :version
 
+      # Public: Registered definitions (list of metadata).
       attr_reader :definitions
 
+      # Public: Constructor.
       def initialize(version = 1, &block)
         @version = version
         @definitions = []
@@ -18,6 +23,10 @@ module Stargate
         instance_eval(&block) if block_given?
       end
 
+      # Public: Registers given class in this registry. A class can be registered with different name using
+      # the `:as` params key.
+      #
+      # Raises ClassAlreadyRegisteredError if class is already registered.
       def serve(klass, params = {}, &block)
         raise ClassAlreadyRegisteredError, "Class already registered: #{klass.name}" if registered?(klass)
 
@@ -29,15 +38,24 @@ module Stargate
         self
       end
 
+      # Internal: Returns true when given class is already registered.
       def registered?(klass)
         @definitions.find { |metadata| metadata.klass == klass }
       end
 
+      # Internal: Finds metadata information for given object (namely for the class of given object).
+      #
+      # Returns Stargate::Metadata if found.
+      # Raises ClassNotExposedError if not found.
       def metadata_for(obj)
         metadata = @definitions.find { |metadata| metadata.klass == obj.class }
         metadata or raise ClassNotExposedError, "Class not registered: #{obj.class.name}"
       end
 
+      # Internal: Finds metadata information for given class.
+      #
+      # Returns Stargate::Metadata if found.
+      # Raises ClassNotExposedError if not found.
       def [](klass_name)
         metadata = @definitions.find { |metadata| metadata.name == klass_name }
         metadata or raise ClassNotExposedError, "Class not registered under name: #{klass_name}"

data/lib/stargate/version.rb

@@ -1,3 +1,3 @@
 module Stargate
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/stargate.gemspec

@@ -37,6 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", "~> 4.0", ">= 3.0"
   spec.add_dependency "sinatra", "~> 1.4"
   spec.add_dependency "rest-client", "~> 1.8"
-  spec.add_dependency "log4r", "~> 1.1"
-  spec.add_dependency "perfume", "~> 0.3", ">= 0.3.1"
+  spec.add_dependency "gallus"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stargate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - jobandtalent
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -268,39 +268,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: log4r
+  name: gallus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: perfume
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0'
 description: Stargate opens a portal to call remote methods via simple and reliable
   RPC protocols.
 email:
@@ -337,7 +317,6 @@ files:
 - lib/stargate/codec/bencode.rb
 - lib/stargate/codec/json.rb
 - lib/stargate/codec/message_pack.rb
-- lib/stargate/errors.rb
 - lib/stargate/marshal.rb
 - lib/stargate/marshal/marshaller.rb
 - lib/stargate/marshal/payload.rb

data/lib/stargate/errors.rb

@@ -1,4 +0,0 @@
-module Stargate
-  # Public: Base error.
-  Error = Class.new(StandardError)
-end