restpack_core_client 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWNkNmU5M2I0NWFkNzgwNWM0NDE0MTIzOTVjZDc2NWY5ZTRmOTMwYw==
+  data.tar.gz: !binary |-
+    YTMyMzViZjVjODc3NjA0OTUxZjlkMjU3OGRmMTk4YzdlZjY1MTkxNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTZlYzU3ZjU0MDIwNjc1MTZmY2FkMzE3MzU4MTNkZmZlNTc0ZTE2ZjkzZjBj
+    NDMxNDgzOTc0OGRkMjkyYTgxYTU1ODYyNDQxM2U2ZjBmYmUwNGZkZmM3M2I1
+    ZjZkYzhkN2M2NGU2ZTE5OTlhNDBjYWEwY2NmYWIxN2VhODM4YWU=
+  data.tar.gz: !binary |-
+    MGUyMTllOGZkYWJhMmM1YTc0YzM4MDE2Y2E3ZjcyNjA3N2MxNjhhYmY5MGRh
+    ZjI0ZDk3ZTI5YzEzMDFhMzk3YjFkZmU2Y2RiYjVlY2NiZGMxY2U4MDg2NTg4
+    YTg2MjkxMGMxZDU0YWMzYWU1ZDVkYTZmZDIyY2Y3ZGIyNzc0MjA=

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do 
+  gem 'rspec', :require => 'spec'
+end
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Gavin Joyce and RestPack contributors
+
+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,20 @@
+# RestPack core.client [![Build Status](https://travis-ci.org/RestPack/restpack_core_client.png?branch=master)](https://travis-ci.org/RestPack/restpack_core_client) [![Dependency Status](https://gemnasium.com/RestPack/restpack-core-client.png)](https://gemnasium.com/RestPack/restpack_core_client)
+
+A client gem for restpack_core_service
+
+## Using the gem
+
+Instructions coming soon...
+
+## Developer Environment Setup
+
+```
+bundle install
+```
+
+## Running Tests
+
+```
+rake test
+```
+

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+task :test => :spec
+
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all specs"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ['-cfs']
+  end
+rescue LoadError
+end
+
+task :gem do
+  ["gem:build", "gem:push"].each do |task|
+    Rake::Task[task].reenable
+    Rake::Task[task].invoke
+  end
+end
+
+namespace :gem do
+  task :build do
+    sh "gem build restpack_core_client.gemspec"
+  end
+
+  task :push do
+    sh "gem push restpack_core_client-#{RestPack::Core::Client::VERSION}.gem"
+  end
+end

data/lib/restpack_core_client/api.rb

@@ -0,0 +1,64 @@
+require_relative 'models/channel'
+require_relative 'models/application'
+require_relative 'models/domain'
+require_relative 'models/configuration'
+
+module RestPack
+  module Core
+    module Client
+      class API
+        def initialize(domain, access_key)
+          @domain = domain
+          @access_key = access_key
+        end
+
+        def get_channel(id)
+          json = RestClient.get("http://:#{@access_key}@#{@domain}/api/v1/channels/#{id}.json")
+          data = Yajl::Parser.parse(json, :symbolize_keys => true)
+
+          hydrate_channel(data)
+        end
+
+        def get_domain(host)
+          json = RestClient.get("http://:#{@access_key}@#{@domain}/api/v1/domains/search.json?host=#{host}")
+          result = Yajl::Parser.parse(json, :symbolize_keys => true)
+
+          raise "host is not configured: #{host}" if result.empty?
+
+          result[:domains].first
+        end
+
+        def root_configurations
+          json = RestClient.get("http://:#{@access_key}@#{@domain}/api/v1/configurations/root.json")
+          data = Yajl::Parser.parse(json, :symbolize_keys => true)
+
+          configurations = []
+          data[:configurations].each do |configuration_data|
+            configurations << Configuration.new(configuration_data)
+          end
+          configurations
+        end
+
+        private
+
+        def hydrate_channel(channel_response)
+          channel = Channel.new(channel_response[:channels].first)
+
+          channel_response[:applications].each do |application_data|
+            Application.new(application_data, channel)
+          end
+
+          channel_response[:domains].each do |domain_data|
+            Domain.new(domain_data, channel)
+          end
+
+          channel_response[:configurations].each do |configuration_data|
+            Configuration.new(configuration_data, channel)
+          end
+
+          channel
+        end
+      end
+    end
+  end
+end

data/lib/restpack_core_client/cache.rb

@@ -0,0 +1,39 @@
+module RestPack
+  module Core
+    module Client
+      class Cache
+        attr_accessor :configurations
+
+        def initialize(api)
+          @api = api
+          @channel_ids = {}
+          @channels = {}
+          @configurations = api.root_configurations
+        end
+
+        def self.create(domain, access_key)
+          api = RestPack::Core::Client::API.new(domain, access_key)
+          Cache.new(api)
+        end
+
+        def get_channel(host)
+          channel_id = get_channel_id(host)
+          @channels[channel_id] ||= @api.get_channel(channel_id)
+        end
+
+        def get_channel_id(host)
+          @channel_ids[host] ||= @api.get_domain(host)[:channel_id]
+        end
+
+        def get_configuration(key)
+          @configurations.find { |c| c.key == key.to_s }
+        end
+        
+        def get_configuration_value(key, default_value = nil)
+          config = get_configuration(key)
+          config.nil? ? default_value : config.value
+        end
+      end
+    end
+  end
+end

data/lib/restpack_core_client/models/application.rb

@@ -0,0 +1,34 @@
+module RestPack::Core::Client
+  class Application
+    attr_accessor :id, :name, :href, :channel, :domains, :configurations
+
+    def initialize(data, channel)
+      @domains        = []
+      @configurations = []
+
+      @id = data[:id].to_i
+      @name = data[:name]
+      @href = data[:href]
+
+      @channel = channel
+      @channel.applications << self
+    end
+
+    def get_configuration_by_key(key)
+      @configurations.find { |c| c.key == key.to_s }
+    end
+
+    def known_domain_names
+      configuration = get_configuration_by_key(:domains)
+      configuration.nil? ? {} : configuration.value
+    end
+
+    def home_domain #TODO: GJ: dynamic
+      known_domain_names[:home]
+    end
+
+    def auth_domain
+      known_domain_names[:auth]
+    end
+  end
+end

data/lib/restpack_core_client/models/channel.rb

@@ -0,0 +1,31 @@
+module RestPack::Core::Client
+  class Channel
+    attr_accessor :id, :name, :href, :applications, :domains, :configurations
+
+    def initialize(data)
+      @applications   = []
+      @domains        = []
+      @configurations = []
+
+      @id = data[:id].to_i
+      @name = data[:name]
+      @href = data[:href]
+    end
+
+    def get_application(id)
+      @applications.find { |a| a.id == id.to_i }
+    end
+
+    def get_domain(id)
+      @domains.find { |a| a.id == id.to_i }
+    end
+
+    def get_domain_by_host(host)
+      @domains.find { |a| a.host == host }
+    end
+
+    def get_configuration(id)
+      @configurations.find { |a| a.id == id.to_i }
+    end
+  end
+end

data/lib/restpack_core_client/models/configuration.rb

@@ -0,0 +1,23 @@
+module RestPack::Core::Client
+  class Configuration
+    attr_accessor :id, :key, :value, :href, :channel, :application, :domain
+
+    def initialize(data, channel = nil)
+      @id = data[:id].to_i
+      @key = data[:key]
+      @value = data[:value]
+      @href = data[:href]
+
+      if channel
+        @channel = channel
+        @application = channel.get_application(data[:application_id])
+        @domain = channel.get_domain(data[:domain_id])
+
+        @channel.configurations << self
+        @application.configurations << self if @application
+        @domain.configurations << self if @domain
+      end
+    end
+
+  end
+end

data/lib/restpack_core_client/models/domain.rb

@@ -0,0 +1,19 @@
+module RestPack::Core::Client
+  class Domain
+    attr_accessor :id, :host, :href, :channel, :application, :configurations
+
+    def initialize(data, channel)
+      @configurations = []
+
+      @id = data[:id].to_i
+      @host = data[:host]
+      @href = data[:href]
+
+      @channel = channel
+      @application = channel.get_application(data[:links][:application])
+
+      @channel.domains << self
+      @application.domains << self
+    end
+  end
+end

data/lib/restpack_core_client/version.rb

@@ -0,0 +1,7 @@
+module RestPack
+  module Core
+    module Client
+      VERSION = "0.2.0"
+    end
+  end
+end

data/lib/restpack_core_client.rb

@@ -0,0 +1,5 @@
+require 'restpack_core_client/version'
+require 'restpack_core_client/api'
+require 'restpack_core_client/cache'
+require 'rest_client'
+require 'yajl'

data/restpack_core_client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restpack_core_client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "restpack_core_client"
+  gem.version       = RestPack::Core::Client::VERSION
+  gem.authors       = ["Gavin Joyce"]
+  gem.email         = ["gavinjoyce@gmail.com"]
+  gem.description   = %q{A simple client gem for restpack-core-service}
+  gem.summary       = %q{A simple client gem for restpack-core-service}
+  gem.homepage      = "https://github.com/RestPack"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rest-client', '~> 1.6.7'
+  gem.add_dependency 'yajl-ruby', '~> 1.1.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.12.1'
+  gem.add_development_dependency 'rake', '~> 10.0.3'
+end

data/spec/api_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe RestPack::Core::Client::API do
+  let(:api) { RestPack::Core::Client::API.new('domain', 'access_key') }
+
+  describe '.get_channel' do
+    before do
+      json = File.read("#{Bundler.root}/spec/fixtures/get_channel.json")
+      RestClient.stub(:get).and_return(json)
+    end
+    context 'the returned channel' do
+      let(:channel) { api.get_channel(31) }
+
+      it 'has correct attributes' do
+        channel.id.should == 31
+        channel.name.should == 'RestPack Sample Apps'
+        channel.href.should == '/api/v1/channels/31.json'
+      end
+
+      it 'has applications' do
+        channel.applications.length.should == 1
+        channel.applications[0].id.should == 43
+        channel.applications[0].name.should == 'Simple Sinatra App'
+        channel.applications[0].href.should == '/api/v1/applications/43.json'
+        channel.applications[0].channel.should == channel
+      end
+
+      it 'has domains' do
+        channel.domains.length.should == 3
+        channel.domains[0].id.should == 83
+        channel.domains[0].host.should == 'sinatra-sample.restpack.io'
+        channel.domains[0].href.should == '/api/v1/domains/83.json'
+        channel.domains[0].channel.should == channel
+        channel.domains[0].application.should_not == nil
+      end
+
+      it 'has configurations' do
+        channel.configurations.length.should == 2
+        channel.configurations[0].id.should == 98
+        channel.configurations[0].key.should == 'domains'
+        channel.configurations[0].value.should == {
+            home: "sinatra-sample.restpack.io:9001",
+            auth: "auth.restpack.io:8081"
+        }
+        channel.configurations[0].href.should == '/api/v1/configurations/98.json'
+      end
+    end
+  end
+end

data/spec/cache_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'restpack_core_client/cache'
+
+describe RestPack::Core::Client::Cache do
+  let(:api) { RestPack::Core::Client::API.new('core.internal.domain.ie', 'password') }
+  let(:cache) { RestPack::Core::Client::Cache.new(api) }
+
+  context "with an empty cache" do
+    pending
+  end
+end

data/spec/fixtures/get_channel.json

@@ -0,0 +1,184 @@
+{
+    "channels": [
+        {
+            "id": "31",
+            "name": "RestPack Sample Apps",
+            "href": "/api/v1/channels/31.json"
+        }
+    ],
+    "meta": {
+        "channels": {
+            "page": 1,
+            "page_size": 50,
+            "count": 1,
+            "includes": [
+                "applications",
+                "domains",
+                "configurations"
+            ],
+            "page_count": 1,
+            "previous_page": null,
+            "next_page": null,
+            "previous_href": null,
+            "next_href": null
+        },
+        "applications": {
+            "page": 1,
+            "page_size": 50,
+            "count": 1,
+            "includes": [],
+            "page_count": 1,
+            "previous_page": null,
+            "next_page": null,
+            "previous_href": null,
+            "next_href": null
+        },
+        "domains": {
+            "page": 1,
+            "page_size": 50,
+            "count": 3,
+            "includes": [],
+            "page_count": 1,
+            "previous_page": null,
+            "next_page": null,
+            "previous_href": null,
+            "next_href": null
+        },
+        "configurations": {
+            "page": 1,
+            "page_size": 50,
+            "count": 2,
+            "includes": [],
+            "page_count": 1,
+            "previous_page": null,
+            "next_page": null,
+            "previous_href": null,
+            "next_href": null
+        }
+    },
+    "links": {
+        "channels.applications": {
+            "href": "/api/v1/applications.json?channel_id={channels.id}",
+            "type": "applications"
+        },
+        "channels.domains": {
+            "href": "/api/v1/domains.json?channel_id={channels.id}",
+            "type": "domains"
+        },
+        "channels.configurations": {
+            "href": "/api/v1/configurations.json?channel_id={channels.id}",
+            "type": "configurations"
+        },
+        "applications.channel": {
+            "href": "/api/v1/channels/{applications.channel}.json",
+            "type": "channels"
+        },
+        "applications.domains": {
+            "href": "/api/v1/domains.json?application_id={applications.id}",
+            "type": "domains"
+        },
+        "applications.configurations": {
+            "href": "/api/v1/configurations.json?application_id={applications.id}",
+            "type": "configurations"
+        },
+        "domains.channel": {
+            "href": "/api/v1/channels/{domains.channel}.json",
+            "type": "channels"
+        },
+        "domains.application": {
+            "href": "/api/v1/applications/{domains.application}.json",
+            "type": "applications"
+        },
+        "domains.configurations": {
+            "href": "/api/v1/configurations.json?domain_id={domains.id}",
+            "type": "configurations"
+        },
+        "configurations.channel": {
+            "href": "/api/v1/channels/{configurations.channel}.json",
+            "type": "channels"
+        },
+        "configurations.application": {
+            "href": "/api/v1/applications/{configurations.application}.json",
+            "type": "applications"
+        },
+        "configurations.domain": {
+            "href": "/api/v1/domains/{configurations.domain}.json",
+            "type": "domains"
+        }
+    },
+    "applications": [
+        {
+            "id": "43",
+            "name": "Simple Sinatra App",
+            "href": "/api/v1/applications/43.json",
+            "links": {
+                "channel": "31"
+            }
+        }
+    ],
+    "domains": [
+        {
+            "id": "83",
+            "host": "sinatra-sample.restpack.io",
+            "href": "/api/v1/domains/83.json",
+            "links": {
+                "channel": "31",
+                "application": "43"
+            }
+        },
+        {
+            "id": "84",
+            "host": "rails-sample.restpack.io",
+            "href": "/api/v1/domains/84.json",
+            "links": {
+                "channel": "31",
+                "application": "43"
+            }
+        },
+        {
+            "id": "85",
+            "host": "auth.restpack.io",
+            "href": "/api/v1/domains/85.json",
+            "links": {
+                "channel": "31",
+                "application": "43"
+            }
+        }
+    ],
+    "configurations": [
+        {
+            "id": "98",
+            "key": "domains",
+            "value": {
+                "home": "sinatra-sample.restpack.io:9001",
+                "auth": "auth.restpack.io:8081"
+            },
+            "href": "/api/v1/configurations/98.json",
+            "links": {
+                "channel": "31",
+                "application": "43",
+                "domain": ""
+            }
+        },
+        {
+            "id": "99",
+            "key": "omniauth",
+            "value": {
+                "twitter": {
+                    "consumer_key": "aaa",
+                    "consumer_secret": "bbb"
+                },
+                "google_oauth2": {
+                    "consumer_key": "35232323.apps.googleusercontent.com",
+                    "consumer_secret": "ccc"
+                }
+            },
+            "href": "/api/v1/configurations/99.json",
+            "links": {
+                "channel": "31",
+                "application": "43",
+                "domain": ""
+            }
+        }
+    ]
+}

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+require 'rspec'
+
+require 'restpack_core_client'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: restpack_core_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Gavin Joyce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 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.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: A simple client gem for restpack-core-service
+email:
+- gavinjoyce@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/restpack_core_client.rb
+- lib/restpack_core_client/api.rb
+- lib/restpack_core_client/cache.rb
+- lib/restpack_core_client/models/application.rb
+- lib/restpack_core_client/models/channel.rb
+- lib/restpack_core_client/models/configuration.rb
+- lib/restpack_core_client/models/domain.rb
+- lib/restpack_core_client/version.rb
+- restpack_core_client.gemspec
+- spec/api_spec.rb
+- spec/cache_spec.rb
+- spec/fixtures/get_channel.json
+- spec/spec_helper.rb
+homepage: https://github.com/RestPack
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A simple client gem for restpack-core-service
+test_files:
+- spec/api_spec.rb
+- spec/cache_spec.rb
+- spec/fixtures/get_channel.json
+- spec/spec_helper.rb