storehouse_client 0.0.8

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jon Gillies
+
+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,60 @@
+# StorehouseClient
+
+This the API client to the Storehouse application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'storehouse_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install storehouse_client
+
+## Usage
+
+The storehouse_client is simple to use.  Here is a complete working example.  Assuming you have a one data source defined in the target Storehouse.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'storehouse_client'
+
+# Setup your data source in the web application, change this as required
+data_source_id = 1
+
+# Create a new client instance
+sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+# Start the export run
+sc.start_run(data_source_id)
+
+# Iterate your data source, use a simple counter for the primary key
+count = 0
+File.open('/usr/share/dict/words').each do |line|
+
+  count += 1
+
+  sc.add_record(count, line)
+
+  puts "Added #{line}"
+
+end
+
+sc.finish_run
+```
+
+See other examples in the 'examples' directory.
+
+## Contributing
+
+1. Fork it
+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/lib/storehouse_client.rb

@@ -0,0 +1,157 @@
+require 'storehouse_client/version'
+require 'yaml'
+require 'crack'
+require 'json'
+require 'rest-client'
+require 'digest'
+
+module StorehouseClient
+
+
+  class API
+
+    YAML::ENGINE.yamler = 'syck'
+
+    attr_reader :run_id, :data_source_id, :record_count, :error, :record_count, :duration
+
+    def initialize(args)
+
+      @error = nil
+      @url = args.fetch(:url) { raise 'You must provide :url' }
+      @api_version = args.fetch(:api_version) { 1 }
+      @auth_token = args.fetch(:auth_token) { raise 'You must provide :auth_token' }
+      @record_count = 0
+      @duration = nil
+
+      @resource = RestClient::Resource.new @url
+
+    end
+
+    def error?
+      !@error.nil?
+    end
+
+    def data_sources
+      get ("data_sources.json?auth_token=#{@auth_token}")
+    end
+
+    def start_run(data_source_id)
+
+      @data_source_id = data_source_id
+
+      run = {}
+      run['export_run'] = {}
+      run['export_run']['data_source_id'] = @data_source_id
+      run['export_run']['started_at'] = Time.now
+
+      r = post("api/#{@api_version}/export_runs?auth_token=#{@auth_token}", run)
+
+      return nil if error?
+
+      @run_id = r['response']['id']
+
+      self
+    end
+
+    def finish_run
+
+      run = {}
+      run['export_run'] = {}
+      run['export_run']['finished_at'] = Time.now.to_s
+      run['export_run']['record_count'] = @record_count
+
+      r = put("api/#{@api_version}/export_runs/#{@run_id}?auth_token=#{@auth_token}", run)
+
+      return nil if error?
+
+      @duration = r['response']['duration']
+
+      self
+    end
+
+    def add_record(primary_key, data)
+
+      # primary_key must be a string
+
+      e = {}
+      e['export_record'] = {}
+      e['export_record']['blob_attributes'] = {}
+      e['export_record']['blob_attributes']['data'] = data
+      e['export_record']['blob_attributes']['checksum'] = Digest::SHA256.hexdigest(data.to_json)
+      e['export_record']['record_size'] = data.to_json.length
+      e['export_record']['checksum'] = e['export_record']['blob_attributes']['checksum']
+      e['export_record']['primary_key'] = primary_key.to_s # Ensure primary key is a string
+      e['export_record']['data_source_id'] = @data_source_id
+      e['export_record']['export_run_id'] = @run_id
+
+      post("api/#{@api_version}/export_records/?auth_token=#{@auth_token}", e)
+
+      return nil if error?
+
+      @record_count += 1
+
+      self
+    end
+
+    private
+
+    def post(path, data)
+      begin
+        result = @resource[path].post data.to_json, content_type: :json, accept: :json
+      rescue RestClient::Unauthorized => @error
+        return nil
+      rescue RestClient::UnprocessableEntity => @error
+        return nil
+      rescue RestClient::ResourceNotFound => @error
+        return nil
+      end
+
+      parse_result result
+    end
+
+    def put(path, data)
+      begin
+        result = @resource[path].put data.to_json, content_type: :json, accept: :json
+      rescue RestClient::Unauthorized => @error
+        return nil
+      rescue RestClient::UnprocessableEntity => @error
+        return nil
+      rescue RestClient::ResourceNotFound => @error
+        return nil
+      end
+
+      parse_result result
+    end
+
+    def get(path)
+      begin
+        result = @resource[path].get content_type: :json, accept: :json
+      rescue RestClient::Unauthorized => @error
+        return nil
+      rescue RestClient::ResourceNotFound => @error
+        return nil
+      end
+
+      parse_result result
+    end
+
+    def parse_result(result)
+      # Go figure?  When the gem is installed, the Crack::JSON will return "invalid json string" WTF?
+      # So fall back to JSON.parse if that happens?
+      begin
+        r = Crack::JSON.parse(result)
+      rescue Crack::ParseError
+        r = JSON.parse(result)
+      rescue Exception => @error
+      end
+
+      r
+    end
+
+    def get_run(run_id)
+      get("api/#{@api_version}/export_runs/#{run_id}?auth_token=#{@auth_token}")
+    end
+
+  end
+
+end

data/lib/storehouse_client/version.rb

@@ -0,0 +1,9 @@
+module StorehouseClient
+  VERSION = '0.0.8'
+  AUTHORS = ['Jon Gillies']
+  EMAIL = %w(supercoder@gmail.com)
+  DESCRIPTION = %q{This the API client to the Storehouse application.}
+  SUMMARY = %q{API client to the Storehouse}
+  HOMEPAGE = 'https://github.com/jongillies/storehouse'
+  VERSION_BANNER = "#{self.name} #{self::VERSION} #{self::SUMMARY} (c) 2013 #{self::AUTHORS.join(', ')}"
+end

data/spec/client_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'storehouse_client'
+
+describe 'Initializing the class' do
+
+  it 'should fail with no options' do
+    expect { StorehouseClient::API.new({}) }.to raise_error
+  end
+
+  it 'should fail without the :url option' do
+    expect { StorehouseClient::API.new(auth_token: 'z0000000000000000000') }.to raise_error
+  end
+
+  it 'should fail without the :auth_token option' do
+    expect { StorehouseClient::API.new(url: 'http://localhost:3000') }.to raise_error
+  end
+
+  it 'should succeed with the proper options' do
+    expect { StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000') }.not_to raise_error
+  end
+
+end
+
+describe 'Fail me' do
+
+  it 'should fail with an invalid auth_token' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z00000000000000000xxxx')
+
+    sc.start_run(1)
+
+    sc.error.http_code.should eq(401)
+
+  end
+
+  it 'should fail with an invalid data_source_id' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(100)
+
+    sc.error.http_code.should eq(422)
+
+  end
+
+  it 'should fail with a duplicate record' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(1)
+
+    text = RandomText.new.output(10).capitalize + '.'
+
+    sc.add_record(1, text)
+    sc.add_record(1, text)
+
+    sc.error.http_code.should eq(422)
+
+  end
+
+end
+
+describe 'Loading data_sources' do
+
+  it 'should load the data sources' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+    sc.data_sources.count.should eq(4)
+  end
+
+end
+
+describe 'Starting and Stopping Runs' do
+
+  it 'should start a run' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(1)
+
+    sc.data_source_id.should eq(1)
+  end
+
+  it 'should start and end a run' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+    sc.start_run(1)
+
+    sc.finish_run
+
+    sc.record_count.should eq(0)
+  end
+
+end
+
+describe 'Add records and ensure types are converted properly' do
+
+  it 'should ensure the primary key is a string' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(1)
+
+    text = RandomText.new.output(10).capitalize + '.'
+
+    sc.add_record(1, text)
+
+    sc.finish_run
+    sc.record_count.should eq(1)
+
+  end
+
+  it 'should convert the "data" to JSON if it is not a string' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(1)
+
+    hash = { value: 'two', type: 'test stuff', other_thing: 1}
+
+    sc.add_record(1, hash)
+
+    sc.finish_run
+    sc.record_count.should eq(1)
+  end
+
+end
+
+describe 'Adding Export Records' do
+
+  it 'should add unique export records' do
+
+    record_count = 10
+    data_source_id = 1
+
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(data_source_id)
+
+    record_count.times do |i|
+
+      text = RandomText.new.output(10).capitalize + '.'
+
+      sc.add_record(i, text)
+
+    end
+
+    sc.finish_run
+    sc.record_count.should eq(record_count)
+
+  end
+
+  it 'should start and end a run' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+    sc.start_run(1)
+
+    sc.finish_run
+
+    sc.record_count.should eq(0)
+  end
+
+end

data/spec/small_test_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'storehouse_client'
+
+describe 'Add one record' do
+
+  it 'should add one record' do
+    sc = StorehouseClient::API.new(url: 'http://localhost:3000', auth_token: 'z0000000000000000000')
+
+    sc.start_run(1)
+
+    hash = { value: 'two', type: 'test stuff', other_thing: 1}
+
+    sc.add_record(1, hash)
+
+    sc.finish_run
+    sc.record_count.should eq(1)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'lorem'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+class RandomText
+  def initialize
+    @lorem_unit = 'words'
+    @max_lorems = 2000
+
+    @seed_text = Lorem::Base.new(@lorem_unit, @max_lorems).output
+
+  end
+  def output(max_output)
+    out = @seed_text.split
+    pos = rand(out.length - max_output)
+    start_pos = (pos < 0 ? 0 : pos)
+    end_pos = (pos + max_output > out.length ? out.length - max_output : pos + max_output)
+    return out[start_pos..end_pos].join(" ")
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: storehouse_client
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- Jon Gillies
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lorem
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This the API client to the Storehouse application.
+email:
+- supercoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- Gemfile
+- lib/storehouse_client/version.rb
+- lib/storehouse_client.rb
+- spec/client_spec.rb
+- spec/small_test_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE.txt
+homepage: https://github.com/jongillies/storehouse
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: API client to the Storehouse
+test_files: []