barrister-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcf3199f32088494e519192f36e76ada5ebda938
+  data.tar.gz: 7f05224550b54e45507b659fa3e70601b8bc5687
+SHA512:
+  metadata.gz: 31b96e510cbff54265d994588638e6b206814d705f859b8fc2f4d75b7816017de354da0be2422cbaac368dace70b0c61224dc081776ccf670106ba805c4ebbfe
+  data.tar.gz: 3e9b469248bea6c49f149ec484bc6e71c5d9cdcde6f919693d46b8001181994aef7530850643ee1cfe5bf8800b591d5743f6cdca50271d7bcbbff2527291e5ae

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in barrister-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Erin Swenson-Healey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Erin Swenson-Healey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# barrister-rails
+
+A wrapper for the Barrister Ruby client, for Rails. Transmutes the hashes
+representing custom IDL structs to instances of runtime-generated psuedo-models
+that implement the ActiveModel interface - allowing them to be consumed easily
+by your Rails views.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'barrister-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barrister-rails
+
+## A note on the hash-to-model transmute
+
+By default, the Barrister Rails client transmutes hashes (representing structs
+in the IDL) to instances of runtime-defined classes that implement the
+ActiveModel interface. This allows data from the server to be consumed easily
+by Rails' view helpers. Note that these classes will only be created if a
+class of the same name cannot be found. If you want to implement your own class
+that the Rails client will instantiate, simply define it in app/models using
+the name of the struct from the IDL.
+
+## Usage
+
+### Setup
+
+By default, the barrister-rails client assumes your server is reachable via http:
+
+```ruby
+
+c = Barrister::Rails::Client.new 'http://localhost:3001/api'
+
+```
+
+If an alternative transport is desired, simply instantiate it and pass it to the
+client's constructor:
+
+```ruby
+
+redis_transport = Barrister::Transports::Redis.new 'some_channel_name'
+c = Barrister::Rails::Client.new redis_transport
+
+```
+
+### Usage
+
+Upon instantiation, the Barrister client will attempt to pull down the JSON
+representation of the IDL file used by the Barrister server. Assuming an
+interface has been defined in the IDL, you can call methods on it like so:
+
+```ruby
+
+users = c.UserService.get_all_users
+puts users
+=> [#<User email: "smasd", full_name: "Joe", id: 9, phone_number: "2069990811">,
+ #<User email: "smurf", full_name: "Bob", id: 10, phone_number: "234234234">]
+
+```
+
+### Disabling hash-to-model transmute
+
+To disable the runtime creation of classes and conversion of Ruby hashes,
+simply pass a false-value on the (optional) configuration hash at the time
+of instantiation:
+
+```ruby
+
+c = Barrister::Rails::Client.new 'http://localhost:3001/api', transmute_to_model: false
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/barrister-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/barrister-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barrister-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "barrister-rails"
+  spec.version       = Barrister::Rails::VERSION
+  spec.authors       = ["Erin Swenson-Healey"]
+  spec.email         = ["erin.swenson.healey@gmail.com"]
+  spec.summary       = %q{A Rails-oriented wrapper for the Barrister client.}
+  spec.description   = %q{More to come!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "barrister", "~> 0"
+  spec.add_dependency "active_attr", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "rspec", "~> 2.0"
+end

data/lib/barrister-rails/version.rb

@@ -0,0 +1,9 @@
+module Barrister
+
+  module Rails
+
+    VERSION = "0.0.1"
+
+  end
+
+end

data/lib/barrister-rails.rb

@@ -0,0 +1,131 @@
+require "barrister"
+require 'active_attr'
+require "barrister-rails/version"
+
+module Barrister
+
+  module Rails
+
+    class Client
+
+      DEFAULT_BARRISTER_TYPES = ['bool', 'int', 'string', 'float']
+
+      class BaseEtherealModel
+
+        include ActiveAttr::Model
+
+        # for building a route
+        def to_param
+          "#{id}"
+        end
+
+        # for determining inflection
+        def persisted?
+          !id.nil?
+        end
+
+      end
+
+      class InterfaceProxy
+
+        attr_reader :name
+
+        def initialize(name, client, fx_metadata, transmute_to_model)
+          @name               = name
+          @client             = client
+          @fx_metadata        = fx_metadata
+          @transmute_to_model = transmute_to_model
+        end
+
+        def method_missing(name, *args)
+          result = @client.send(@name).send(name, *args)
+
+          if @transmute_to_model == true and DEFAULT_BARRISTER_TYPES.include?(@fx_metadata[name][:type]) == false
+            cast result, @fx_metadata[name][:type], @fx_metadata[name][:is_array]
+          else
+            result
+          end
+        end
+
+        def ensure_const(type)
+          return Object.const_get(type) if Object.const_defined?(type)
+
+          klass = Class.new(BaseEtherealModel)
+
+          a = attributes_for_type(type).map { |name| "attribute :#{name};" }
+
+          klass.class_eval a.join('')
+
+          Object.send(:const_set, type, klass)
+
+          klass
+        end
+
+        def cast(result, type, is_array)
+          klass = ensure_const(type)
+
+          if is_array
+            result.map { |result| klass.new result }
+          else
+            klass.new result
+          end
+        end
+
+        def attributes_for_type(type)
+          structs = @client
+            .instance_variable_get('@contract')
+            .instance_variable_get('@structs')
+
+          all_struct_fields([], structs[type], structs).map { |f| f['name'] }
+        end
+
+        def all_struct_fields(arr, struct, structs)
+          struct["fields"].each do |f|
+            arr << f
+          end
+
+          if struct["extends"]
+            parent = structs[struct["extends"]]
+            if parent
+              return all_struct_fields(arr, parent, structs)
+            end
+          end
+
+          return arr
+        end
+
+      end
+
+      def initialize(transport_or_uri, opts={})
+        transport = transport_or_uri.is_a?(String) ? Barrister::HttpTransport.new(transport_or_uri) : transport_or_uri
+        @client = Barrister::Client.new(transport)
+        @custom_types = Hash.new
+
+        interfaces = @client
+          .instance_variable_get('@contract')
+          .interfaces
+
+        unless opts[:transmute_to_model] == false
+          pairs = interfaces
+            .map { |iface| iface.functions }
+            .flatten
+            .map { |fx| [fx.name.to_sym, { type: fx.returns['type'], is_array: fx.returns['is_array'] } ] }
+
+          fx_metadata = Hash[pairs]
+        else
+          fx_metadata = {}
+        end
+
+        @interface_proxies = interfaces.map { |iface| InterfaceProxy.new iface.name, @client, fx_metadata, opts[:transmute_to_model] != false }
+      end
+
+      def method_missing(name, *args)
+        name_as_string = name.to_s
+        @interface_proxies.find { |iface_proxy| iface_proxy.name == name_as_string }
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'barrister-rails'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: barrister-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Erin Swenson-Healey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: barrister
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: More to come!
+email:
+- erin.swenson.healey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- barrister-rails.gemspec
+- lib/barrister-rails.rb
+- lib/barrister-rails/version.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Rails-oriented wrapper for the Barrister client.
+test_files:
+- spec/spec_helper.rb