opencomponents 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ad282648e755c0c28348bb1b2c243892bc4c100
+  data.tar.gz: bbee3ca89a7c5b264a7e8b17872efed62f711989
+SHA512:
+  metadata.gz: 0bbfa189e576fd2e24ac401f159adf483d78e67e16a57ba44e87c598e1e493e7d0d87abdb5e121ca58d67adf5b358274c0bcbb4106e48246ec5dbf0c503a77cb
+  data.tar.gz: 03b8c7878cb230499a3f6c5a4e0f1c79684eff6c222c8c76525af770f2267b749eca7f2efef535517c18adb87c27bc334d9318464928342e15c67a7ccd7aed94

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 OpenTable
+
+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,41 @@
+# opencomponents
+[![Build Status](https://travis-ci.org/opentable/ruby-oc.svg?branch=master)](https://travis-ci.org/opentable/ruby-oc)
+[![Coverage Status](https://coveralls.io/repos/opentable/ruby-oc/badge.svg)](https://coveralls.io/r/opentable/ruby-oc)
+
+[OpenComponents][1] for Ruby
+
+[1]:https://github.com/opentable/oc
+
+## Important
+This gem is still under heavy development and the API is likely to change at any
+time.
+
+## Getting Started
+Add the gem to your Gemfile and run `bundle install` (prerelease versions aren't
+on RubyGems):
+```ruby
+gem 'opencomponents', github: 'opentable/ruby-oc'
+```
+
+By default, the gem will attempt to use a component registry located at
+`http://localhost:3030`.
+If you want to use a different registry, you can configure OpenComponents to use
+it with:
+```ruby
+OpenComponents.configure { |config| config.registry = 'http://some.other.host' }
+```
+
+## Integrations
+Individual integrations for rendering components in Rails and Sinatra are
+available.
+  * [opencomponents-rails][2]
+  * [sinatra-opencomponents][3]
+
+[2]:https://github.com/opentable/opencomponents-rails
+[3]:https://github.com/opentable/sinatra-opencomponents
+
+## Contributing
+Would be rad. Open a PR or Issue if you have an idea for improvements.
+
+## License
+Copyright 2015 OpenTable. See LICENSE for details.

data/lib/opencomponents.rb

@@ -0,0 +1,22 @@
+require 'opencomponents/component'
+require 'opencomponents/prerendered_component'
+require 'opencomponents/rendered_component'
+require 'opencomponents/renderer'
+require 'opencomponents/version'
+
+module OpenComponents
+  DEFAULT_REGISTRY = 'http://localhost:3030'
+
+  ComponentNotFound = Class.new(RuntimeError)
+
+  Configuration = Struct.new(:registry)
+  Template      = Struct.new(:src, :type, :key)
+
+  def self.config
+    @@_config ||= Configuration.new(DEFAULT_REGISTRY)
+  end
+
+  def self.configure
+    yield self.config
+  end
+end

data/lib/opencomponents/component.rb

@@ -0,0 +1,71 @@
+require 'rest-client'
+
+module OpenComponents
+  class Component
+    attr_reader :name, :version, :params, :href, :registry_version,
+                :type, :render_mode
+
+    def initialize(name, params = {}, version = '')
+      @name    = name
+      @params  = params
+      @version = version
+    end
+
+    def request_version
+      @request_version == '' ? nil : @request_version
+    end
+
+    def flush!
+      flush_variables_whitelist.each do |var|
+        instance_variable_set(var, nil)
+      end
+
+      self
+    end
+
+    def reload!
+      flush!
+      load
+    end
+
+    protected
+
+    def load
+      @href             = response_data['href']
+      @registry_version = response_data['version']
+      @request_version  = response_data['requestVersion']
+      @type             = response_data['type']
+      @render_mode      = response_data['renderMode']
+
+      self
+    end
+
+    def url
+      File.join(OpenComponents.config.registry, name, version)
+    end
+
+    def response
+      RestClient::Request.execute(
+        method: :get,
+        url: url,
+        timeout: 10,
+        headers: {
+          accept: accept_header,
+          params: params,
+        }
+      )
+    rescue RestClient::ResourceNotFound => e
+      fail ComponentNotFound, e.message
+    end
+
+    def response_data
+      @_response_data ||= JSON.parse(response)
+    end
+
+    private
+
+    def flush_variables_whitelist
+      instance_variables - [:@name, :@version, :@params]
+    end
+  end
+end

data/lib/opencomponents/prerendered_component.rb

@@ -0,0 +1,22 @@
+module OpenComponents
+  class PrerenderedComponent < Component
+    attr_reader :data, :template
+
+    def load
+      template_data = response_data['template']
+
+      @data     = response_data['data']
+      @template = Template.new(
+        template_data['src'], template_data['type'], template_data['key']
+      )
+
+      super
+    end
+
+    private
+
+    def accept_header
+      'application/vnd.oc.prerendered+json'
+    end
+  end
+end

data/lib/opencomponents/rendered_component.rb

@@ -0,0 +1,17 @@
+module OpenComponents
+  class RenderedComponent < Component
+    attr_reader :html
+
+    def load
+      @html = response_data['html']
+
+      super
+    end
+
+    private
+
+    def accept_header
+      nil
+    end
+  end
+end

data/lib/opencomponents/renderer.rb

@@ -0,0 +1,9 @@
+module OpenComponents
+  module Renderer
+    def render_component(component, params = {}, version = '')
+      OpenComponents::RenderedComponent.new(component, params, version)
+        .load
+        .html
+    end
+  end
+end

data/lib/opencomponents/version.rb

@@ -0,0 +1,3 @@
+module OpenComponents
+  VERSION = '0.1.0'
+end

data/opencomponents.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'opencomponents/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'rest-client',  '~> 1.8'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+
+  spec.authors       = ['Todd Bealmear']
+  spec.description   = %q{Consume OpenComponents in Ruby}
+  spec.email         = ['tbealmear@opentable.com']
+  spec.files         = %w(LICENSE README.md opencomponents.gemspec)
+  spec.files        += Dir.glob('lib/**/*.rb')
+  spec.homepage      = 'https://github.com/opentable/ruby-oc'
+  spec.licenses      = ['MIT']
+  spec.name          = 'opencomponents'
+  spec.require_paths = ['lib']
+  spec.summary       = spec.description
+  spec.version       = OpenComponents::VERSION
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: opencomponents
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todd Bealmear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Consume OpenComponents in Ruby
+email:
+- tbealmear@opentable.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/opencomponents.rb
+- lib/opencomponents/component.rb
+- lib/opencomponents/prerendered_component.rb
+- lib/opencomponents/rendered_component.rb
+- lib/opencomponents/renderer.rb
+- lib/opencomponents/version.rb
+- opencomponents.gemspec
+homepage: https://github.com/opentable/ruby-oc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Consume OpenComponents in Ruby
+test_files: []