context_hub_vault 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e9bf7e3e774555283cd7af06fbf1d120a1911e2
+  data.tar.gz: 9fd1418ff2396bd735a5ecd92a6ddd4e28aed0ea
+SHA512:
+  metadata.gz: 6e137fcc8ae38a610bfed751383c42a68f9e9304e0a580965eeef51449910457556cb270213b03dcc163fc1b9f663c77051eb8f0d6205379838951bc983f5a28
+  data.tar.gz: 24f6b6cd4ec4364f13afb3f466eda1ca4bd89c1aa3bf299243c56823fb798a7aa5aa76bf3fb35b88dfc3d5f7d64660e7cf5aa1e7d8430c13e15d00a859849ef4

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/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Boone
+
+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,36 @@
+# ContextHubVault
+
+[![Code Climate](https://codeclimate.com/github/chaione/context_hub_vault.png)](https://codeclimate.com/github/chaione/context_hub_vault/badges)
+
+Ruby client for the ContextHUB vault
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'context_hub_vault'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install context_hub_vault
+
+## Usage
+
+```ruby
+client = ContextHubVault::Client.new(host: 'http://localhost:3000', app_id: '1', auth_token: ENV['AUTH_TOKEN'])
+c.create('music', name: 'Miles Davis', style: 'jazz')
+c.create('music', name: 'Monk', style: 'jazz')
+jazz_musicians = c.search(style: 'jazz')
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/context_hub_vault/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,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'pry'
+  require 'context_hub_vault'
+  ARGV.clear
+  Pry.start
+end

data/context_hub_vault.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'context_hub_vault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'context_hub_vault'
+  spec.version       = ContextHubVault::VERSION
+  spec.authors       = ['Robert Boone']
+  spec.email         = ['robert@chaione.com']
+  spec.description   = %q{Ruby client for the ContextHUB Vault }
+  spec.summary       = spec.description
+  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_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'httparty', '~> 0.10'
+end

data/lib/context_hub_vault.rb

@@ -0,0 +1,25 @@
+require 'context_hub_vault/version'
+require 'context_hub_vault/client'
+
+module ContextHubVault
+  class << self
+    attr_accessor :host, :version, :auth_token, :app_id
+
+    # config/initializers/context_hub_vault.rb (for instance)
+    #
+    # ContextHubVault.configure do |config|
+    #   config.host       = 'example.com'
+    #   config.auth_token = 'qwertyasdfqwerty'
+    #   config.version    = 42
+    #   config.app_id     = 50
+    # end
+    #
+    # elsewhere
+    #
+    # client = ContextHubVault::Client.new
+    def configure
+      yield self
+      true
+    end
+  end
+end

data/lib/context_hub_vault/client.rb

@@ -0,0 +1,86 @@
+require 'httparty'
+
+module ContextHubVault
+  class Client
+    include HTTParty
+    format :json
+
+    def initialize(host: ContextHubVault.host, auth_token: ContextHubVault.auth_token, version: ContextHubVault.version, app_id: ContextHubVault.app_id)
+      if http_prefix(host)
+        self.class.base_uri "#{host}/api"
+      else
+        self.class.base_uri "https://#{host}/api"
+      end
+      self.class.headers('Authorization' => %Q[Token token="#{auth_token}"]) if auth_token
+      self.class.headers('Accept' => "application/vnd.carbon.vault.v#{version}") if version
+      self.class.headers('HTTP_CARBON_APP_ID' => app_id) if app_id
+    end
+
+    # Find a vault by it's vault_id
+    #
+    # @param id [String] vault_id
+    # @return [Hash] The full vault data structure that matches the vault_id
+    def find_by_id(id)
+      search('vault_info.vault_id' => id).first
+    end
+
+    # Search the vault for items that match your query params
+    #
+    # @param query [Hash] search by keyword
+    # @param query [String] javascript language search
+    # @return [Array] An array of the matching search results
+    def search(query = {})
+      get '/vaults', body: { query: query }
+    end
+
+    # Create new vault data
+    #
+    # @param container [String] The name of the vault container
+    # @param data [Hash] A hash of key/value pairs to store in the vault
+    # @return [Hash] The newly created vault
+    def create(container, data = {})
+      fail 'Must include the container' unless container
+
+      data.merge! container: container
+      post '/vaults', body: data
+    end
+
+    # Update vault data
+    #
+    # @param id [String] vault_id
+    # @param data [Hash] Data to update the vault with
+    # @return [Hash] The updated vault data structure
+    def update(id, data = {})
+      patch "/vaults/#{id}", body: data
+    end
+
+    # Delete a vault by vault_id
+    #
+    # @param id [String] vault_id
+    def destroy(id, data = {})
+      delete "/vaults/#{id}"
+    end
+
+    private
+
+    def http_prefix(host)
+      host.downcase.start_with?('http://', 'https://')
+    end
+
+    def post(path, options = {})
+      self.class.post path, options
+    end
+
+    def get(path, options = {})
+      self.class.get path, options
+    end
+
+    def patch(path, options = {})
+      self.class.patch path, options
+    end
+
+    def delete(path, options = {})
+      self.class.delete path, options
+    end
+  end
+end

data/lib/context_hub_vault/version.rb

@@ -0,0 +1,3 @@
+module ContextHubVault
+  VERSION = '0.0.1'
+end

data/spec/context_hub_vault/client_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ContextHubVault::Client do
+  context 'initialization' do
+    let(:host)       { 'example.com' }
+    let(:auth_token) { nil }
+    let(:version)    { nil }
+    let(:app_id)     { nil }
+    let!(:client)    { ContextHubVault::Client.new(host: host, auth_token: auth_token, version: version, app_id: app_id) }
+
+    context 'defaults' do
+      it 'should default to ssl when given a hostname' do
+        client.class.base_uri.should == 'https://example.com/api'
+      end
+
+      it 'should not have the authorization header set' do
+        client.class.headers.should_not have_key('Authorization')
+      end
+
+      it 'should not have the version header set' do
+        client.class.headers.should_not have_key('Accept')
+      end
+    end
+
+    context 'custom' do
+      let(:host) { 'http://example.com:5000' }
+      let(:auth_token) { 'abcdef' }
+      let(:version) { 42 }
+
+      it 'should use http if explicitly defined' do
+        client.class.base_uri.should == 'http://example.com:5000/api'
+      end
+
+      it 'should set the authorization header if given an auth token' do
+        client.class.headers['Authorization'].should eq 'Token token="abcdef"'
+      end
+
+      it 'should set the version header if given a version' do
+        client.class.headers['Accept'].should eq 'application/vnd.carbon.vault.v42'
+      end
+    end
+  end
+end

data/spec/context_hub_vault_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ContextHubVault do
+  it 'should have a version number' do
+    ContextHubVault::VERSION.should_not be_nil
+  end
+
+  it 'should be able to set its attributes via a configuration block' do
+    ContextHubVault.configure do |config|
+      config.host       = 'example.com'
+      config.auth_token = 'qwertyasdfqwerty'
+      config.version    = 42
+      config.app_id     = 50
+    end
+
+    expect(ContextHubVault.host).to       eq('example.com')
+    expect(ContextHubVault.app_id).to     eq(50)
+    expect(ContextHubVault.auth_token).to eq('qwertyasdfqwerty')
+    expect(ContextHubVault.version).to    eq(42)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'context_hub_vault'
+require 'pry'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: context_hub_vault
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Boone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '0'
+  type: :development
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 'Ruby client for the ContextHUB Vault '
+email:
+- robert@chaione.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- context_hub_vault.gemspec
+- lib/context_hub_vault.rb
+- lib/context_hub_vault/client.rb
+- lib/context_hub_vault/version.rb
+- spec/context_hub_vault/client_spec.rb
+- spec/context_hub_vault_spec.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.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for the ContextHUB Vault
+test_files:
+- spec/context_hub_vault/client_spec.rb
+- spec/context_hub_vault_spec.rb
+- spec/spec_helper.rb