orchestrate.io 0.1.3

data/orchestrate.io.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orchestrate.io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "orchestrate.io"
+  spec.version       = OrchestrateIo::VERSION
+  spec.authors       = ["azukiwasher"]
+  spec.email         = ["azukiwasher@higanworks.com"]
+  spec.description   = %q{A Ruby wrapper for the Orchestrate.io API}
+  spec.summary       = %q{A Ruby wrapper for the Orchestrate.io API.}
+  spec.homepage      = "https://github.com/azukiwasher/ruby-orchestrate.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency     "httparty", "~> 0.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'rb-readline'
+end

data/spec/orchestrate.io/client_spec.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::Client do
+  let(:default_options) {{
+    :request_headers=>{
+      "User-Agent"=>"Orchestrate.io Ruby Gem #{OrchestrateIo::Version}",
+      "Content-Type"=>"application/json; charset=utf-8",
+      "Accept-Language"=>"ja,en"
+    },
+    :endpoint=>"https://api.orchestrate.io",
+    :api_key=>"",
+    :version=>"#{OrchestrateIo.options[:version]}",
+    :verbose=>false
+  }}
+
+  describe '::new' do
+    it 'initializes attributes' do
+      client = OrchestrateIo.new(api_key: 'abc')
+      expect(client.request_headers).to eql default_options[:request_headers]
+      expect(client.endpoint).to eql default_options[:endpoint]
+      expect(client.verbose).to eql default_options[:verbose]
+      expect(client.version).to eql default_options[:version]
+      expect(client.api_key).to eql 'abc'
+    end
+
+    it 'initializes options for client' do
+      OrchestrateIo::Client.should_receive(:format).with(:json)
+      OrchestrateIo::Client.should_receive(:base_uri).with(default_options[:endpoint])
+      OrchestrateIo::Client.should_receive(:headers).with(default_options[:request_headers])
+      OrchestrateIo.new(api_key: 'abc')
+    end
+
+    it 'sets logger level to debug' do
+      OrchestrateIo.new(api_key: 'abc', verbose: true)
+      expect(OrchestrateIo.logger.level).to eql Logger::DEBUG
+    end
+
+    it 'sets logger level to info' do
+      OrchestrateIo.new(api_key: 'abc', verbose: false)
+      expect(OrchestrateIo.logger.level).to eql Logger::INFO
+    end
+  end
+
+  describe "#request" do
+    pending "TODO: A lesson for Fujiwara san"
+  end
+
+  describe "#method_missing" do
+    let(:client){ OrchestrateIo::Client.new(api_key: 'abc') }
+    before { OrchestrateIo.stub(:request) }
+
+    context '#key_value' do
+      it 'creates a new key_value ' do
+        request_data = '{ "Title": "The Godfather" }'
+        expect(
+          client.key_value(:get){
+            collection  "films"
+            key         "the_godfather"
+          }
+        ).to be_an_instance_of OrchestrateIo::KeyValue
+      end
+    end
+
+    context '#search' do
+      it 'creates a new search instance' do
+        search_query = "Genre:crime"
+        expect(
+          client.search(:get){
+            collection  "films"
+            query        search_query
+          }
+        ).to be_an_instance_of OrchestrateIo::Search
+      end
+    end
+
+    context '#events' do
+      it 'creates a new event instance' do
+        request_data = '{ "User": "peter_bradshaw", "Text": "A measured, deathly serious epic." }'
+        expect(
+          client.events(:get){
+            collection  "films"
+            key         "the_godfather"
+            type        "comments"
+          }
+        ).to be_an_instance_of OrchestrateIo::Events
+      end
+    end
+
+    context '#graph' do
+      it 'creates a new graph instance' do
+        expect(
+          client.graph(:get){
+            collection  "films"
+            key         "the_godfather"
+            relation    "sequel"
+          }
+        ).to be_an_instance_of OrchestrateIo::Graph
+      end
+    end
+  end
+
+  describe "#basic_auth" do
+    let(:client){ OrchestrateIo::Client.new(api_key: 'abc') }
+    it "returns an object for the basic authentication" do
+      hash = client.__send__(:basic_auth)
+      expect(hash[:basic_auth][:username]).to eql 'abc'
+      expect(hash[:basic_auth][:password]).to be_empty
+    end
+  end
+end

data/spec/orchestrate.io/events_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::Events do
+  let(:client) { OrchestrateIo.new(api_key: 'abc') }
+
+  describe "PUT /:version/:collection/:key/events/:type" do
+    let(:request) {
+      client.events :put do
+        collection "films"
+        key        "the_godfather"
+        type       "comments"
+        data       "{\"Text\" :\"It's hard to find a moment in the film that isn't great.\"}"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:put, "/v0/films/the_godfather/events/comments", {:body=>"{\"Text\" :\"It's hard to find a moment in the film that isn't great.\"}"})
+      request.perform
+    end
+
+    it "returns http created with no body" do
+      response = request.perform
+      expect(response.code).to eql 201
+      expect(response.parsed_response).to be_nil
+    end
+  end
+
+  describe "GET /:version/:collection/:key/events/:type" do
+    let(:request) {
+      client.events :get do
+        collection  "films"
+        key         "the_godfather"
+        type        "comments"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:get, "/v0/films/the_godfather/events/comments", {})
+      request.perform
+    end
+
+    it "returns http created with no body" do
+      response = request.perform
+      expect(response.code).to eql 200
+      expect(response.parsed_response["results"]).to be_instance_of Array
+    end
+  end
+end

data/spec/orchestrate.io/graph_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::Graph do
+  let(:client) { OrchestrateIo::Client.new(api_key: 'abc') }
+
+  describe "PUT /:version/:collection/:key/relations/:relation/:to_collection/:to_key" do
+    let(:request){
+      client.graph :put do
+        collection    "films"
+        key           "the_godfather"
+        relation      "sequel"
+        to_collection "films"
+        to_key        "the_godfather_part_2"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:put, "/v0/films/the_godfather/relations/sequel/films/the_godfather_part_2", {})
+      request.perform
+    end
+
+    it "returns http created with no body"  do
+      response = request.perform
+      expect(response.code).to eql 201
+    end
+  end
+
+  describe "GET /:version/:collection/:key/relations/:relation" do
+     let(:request){
+       client.graph :get do
+         collection    "films"
+         key           "the_godfather"
+         relation      "sequel"
+       end
+     }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:get, "/v0/films/the_godfather/relations/sequel", {})
+      request.perform
+    end
+
+    it "returns http ok with body" do
+      response = request.perform
+      expect(response.code).to eql 200
+      expect(response.parsed_response["results"].first["value"]["Title"]).to eql "The Godfather: Part II"
+    end
+  end
+end

data/spec/orchestrate.io/key_value_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::KeyValue do
+  let(:client){ OrchestrateIo.new(api_key: 'abc') }
+
+  describe "PUT /:version/:collection/:key" do
+    let(:request){
+      client.key_value :put do
+        collection "films"
+        key        "the_godfather"
+        data       "{\"Title\": \"The Godfather\"}"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:put, "/v0/films/the_godfather", {:body=>"{\"Title\": \"The Godfather\"}"})
+      request.perform
+    end
+
+    it "returns http created with no body" do
+      response = request.perform
+      expect(response.code).to eql 201
+      expect(response.parsed_response).to be_nil
+    end
+  end
+
+  describe "GET /:version/:collection/:key" do
+    let(:request){
+      client.key_value :get do
+        collection "films"
+        key        "the_godfather"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).with(:get, "/v0/films/the_godfather", {})
+      request.perform
+    end
+
+    it "returns http ok with body" do
+      response = request.perform
+      expect(response.code).to eql 200
+      expect(response.parsed_response["Director"]).to eql "Akira Kurosawa"
+    end
+  end
+
+  describe "DELETE /:version/:collection/:key" do
+    let(:request){
+      client.key_value :delete do
+        collection "films"
+        key        "the_godfather"
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).with(:delete, "/v0/films/the_godfather", {})
+      request.perform
+    end
+
+    it "returns http no content" do
+      response = request.perform
+      expect(response.code).to eql 204
+    end
+  end
+end

data/spec/orchestrate.io/request_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe OrchestrateIo::Request do
+  class Client
+    def version ; "v0" ; end
+    def request(http_method, uri, options={}) ; 200 ; end
+  end
+
+  let(:request){
+    OrchestrateIo::Request.new(
+      args = {
+        client:      Client.new,
+        http_method: :get,
+        uri:         "/:version/:collection/:key",
+        options:     Hash[:body, :data]
+      }
+    ) do
+      collection "films"
+      key        "the_godfather"
+      data       "{\"Title\": \"The Godfather\"}"
+    end
+  }
+
+  describe "#uri" do
+    it "returns a request uri" do
+      expect(request.uri).to eql "/v0/films/the_godfather"
+    end
+  end
+
+  describe "#parse_options" do
+    context "simple options" do
+      it "returns a request data" do
+        options = Hash[:body, :data]
+        result = {:body=>"{\"Title\": \"The Godfather\"}"}
+        expect(request.parse_options(options)).to eql result
+      end
+    end
+
+    context "nested options" do
+      it "returns a request data" do
+        options = {query:{query: :data}}
+        result = {:query=>{:query=>"{\"Title\": \"The Godfather\"}"}}
+        expect(request.parse_options(options)).to eql result
+      end
+    end
+  end
+
+  describe "#perform" do
+    it "perform a request to the uri with the options" do
+      Client.any_instance.should_receive(:request).with(:get, "/v0/films/the_godfather", {:body=>"{\"Title\": \"The Godfather\"}"}).and_return(200)
+      expect(request.perform). to eql 200
+    end
+  end
+end

data/spec/orchestrate.io/search_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::Search do
+  let(:client){ OrchestrateIo::Client.new(api_key: 'abc') }
+  let(:request){
+    client.search :get do
+      collection  "films"
+      query       "Genre:crime"
+    end
+  }
+
+  describe "GET /:version/:collection" do
+    it "performs a request with the correct options" do
+      client.should_receive(:request).with(:get, "/v0/films", {:query=>{:query=>"Genre:crime"}})
+      request.perform
+    end
+
+    it "returns http ok with body" do
+      response = request.perform
+      expect(response.code).to eql 200
+      expect(response.parsed_response["results"].first["value"]["Genre"]).to eql "Crime, Drama"
+    end
+  end
+end

data/spec/orchestrate.io_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo do
+  let(:default_options) {{
+    :request_headers=>{
+      "User-Agent"=>"Orchestrate.io Ruby Gem #{OrchestrateIo::Version}",
+      "Content-Type"=>"application/json; charset=utf-8",
+      "Accept-Language"=>"ja,en"
+    },
+    :endpoint=>"https://api.orchestrate.io",
+    :api_key=>"",
+    :version=>"#{OrchestrateIo.options[:version]}",
+    :verbose=>false
+  }}
+
+  describe '::new' do
+    it 'creates a new client' do
+      expect(OrchestrateIo.new(api_key: 'abc')).to be_an_instance_of OrchestrateIo::Client
+    end
+  end
+
+  describe '.logger' do
+    it 'initializes logger' do
+      expect(OrchestrateIo.logger).to be_an_instance_of Logger
+    end
+
+    it 'initializes logger by custom formatter' do
+      pending
+      expect(OrchestrateIo.logger.formatter).to be_an_instance_of OrchestrateIo::Logging::Pretty
+    end
+  end
+
+  describe '.logger=' do
+    it 'initializes logger by give logger object' do
+      OrchestrateIo.logger = Logger.new('application.log', 20, 'daily')
+      expect(OrchestrateIo.logger).to be_an_instance_of Logger
+      OrchestrateIo.logger = nil
+    end
+  end
+
+  describe '.options' do
+    it 'returns options reset to defaults' do
+      expect(OrchestrateIo.options).to eql default_options
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+# 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
+
+unless ENV['CI']
+  require 'simplecov'
+  require 'simplecov-rcov'
+
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start do
+    add_filter 'spec'
+    add_filter 'vendor'
+    add_filter 'features'
+  end
+end
+
+require 'orchestrate.io'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+require 'timecop'
+
+# Use Webmock to route all requests to our Sinatra application `PseudoOrchestrateIo`.
+require_relative 'support/pseudo_orchestrate.io'
+
+# Keep the client from external requests.
+WebMock.disable_net_connect!(allow_localhost: true)
+
+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'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Stub any HTTP requests to `api.orchestrate.io` with WebMock
+  # and returns prepended content.
+  config.before(:each) do
+    stub_request(:any, /api.orchestrate.io/).to_rack(PseudoOrchestrateIo.new)
+  end
+end
+
+def load_json(string)
+  JSON.parse(string)
+end
+
+def dump_json(object)
+  JSON.pretty_generate(object)
+end

data/spec/support/fixtures/get_events_by_key.json

@@ -0,0 +1,12 @@
+{
+  "results": [
+    {
+      "value": {
+          "User": "hank_sartin",
+          "Text": "It's hard to find a moment in the film that isn't great. The Godfather lives up to the term masterpiece."
+      },
+      "timestamp": 1384909800669
+    }
+  ],
+  "count": 1
+}

data/spec/support/fixtures/get_graph.json

@@ -0,0 +1,30 @@
+{
+  "results": [
+    {
+      "path": {
+        "collection": "films",
+        "key": "the_godfather_part_2",
+        "ref": "dd76dd28ff14d348"
+      },
+      "value": {
+        "Title": "The Godfather: Part II",
+        "Year": 1974,
+        "Rated": "R",
+        "Released": "20 Dec 1974",
+        "Runtime": "3 h 20 min",
+        "Genre": "Crime, Drama",
+        "Director": "Francis Ford Coppola",
+        "Writer": "Francis Ford Coppola, Mario Puzo",
+        "Actors": "Al Pacino, Robert De Niro, Robert Duvall, Diane Keaton",
+        "Plot": "The early life and career of Vito Corleone in 1920s New York is portrayed while his son, Michael, expands and tightens his grip on his crime syndicate stretching from Lake Tahoe, Nevada to pre-revolution 1958 Cuba.",
+        "Poster": "http://ia.media-imdb.com/images/M/MV5BNDc2NTM3MzU1Nl5BMl5BanBnXkFtZTcwMTA5Mzg3OA@@._V1_SX300.jpg",
+        "imdbRating": 9,
+        "imdbVotes": "473,096",
+        "imdbID": "tt0071562",
+        "Type": "movie",
+        "Response": "True"
+      }
+    }
+  ],
+  "count": 1
+}

data/spec/support/fixtures/get_value_by_key.json

@@ -0,0 +1,18 @@
+{
+    "Title": "Rashomon",
+    "Year": "1950",
+    "Rated": "Unrated",
+    "Released": "26 Dec 1951",
+    "Runtime": "1 h 28 min",
+    "Genre": "Crime, Drama",
+    "Director": "Akira Kurosawa",
+    "Writer": "Ryûnosuke Akutagawa, Akira Kurosawa",
+    "Actors": "Toshirô Mifune, Machiko Kyô, Masayuki Mori, Takashi Shimura",
+    "Plot": "A heinous crime and its aftermath are recalled from differing points of view.",
+    "Poster": "http://ia.media-imdb.com/images/M/MV5BMjEzMzA4NDE2OF5BMl5BanBnXkFtZTcwNTc5MDI2NQ@@._V1_SX300.jpg",
+    "imdbRating": "8.4",
+    "imdbVotes": "69,263",
+    "imdbID": "tt0042876",
+    "Type": "movie",
+    "Response": "True"
+}

data/spec/support/fixtures/get_values_by_key.json

@@ -0,0 +1,18 @@
+{
+    "Title": "Rashomon",
+    "Year": "1950",
+    "Rated": "Unrated",
+    "Released": "26 Dec 1951",
+    "Runtime": "1 h 28 min",
+    "Genre": "Crime, Drama",
+    "Director": "Akira Kurosawa",
+    "Writer": "Ryûnosuke Akutagawa, Akira Kurosawa",
+    "Actors": "Toshirô Mifune, Machiko Kyô, Masayuki Mori, Takashi Shimura",
+    "Plot": "A heinous crime and its aftermath are recalled from differing points of view.",
+    "Poster": "http://ia.media-imdb.com/images/M/MV5BMjEzMzA4NDE2OF5BMl5BanBnXkFtZTcwNTc5MDI2NQ@@._V1_SX300.jpg",
+    "imdbRating": "8.4",
+    "imdbVotes": "69,263",
+    "imdbID": "tt0042876",
+    "Type": "movie",
+    "Response": "True"
+}

data/spec/support/fixtures/search_collection.json

@@ -0,0 +1,32 @@
+{
+  "results": [
+    {
+      "path": {
+        "collection": "films",
+        "key": "kurosawa",
+        "ref": "76bc5546c0a60e92"
+      },
+      "value": {
+        "Title": "Rashomon",
+        "Year": "1950",
+        "Rated": "Unrated",
+        "Released": "26 Dec 1951",
+        "Runtime": "1 h 28 min",
+        "Genre": "Crime, Drama",
+        "Director": "Akira Kurosawa",
+        "Writer": "Ryûnosuke Akutagawa, Akira Kurosawa",
+        "Actors": "Toshirô Mifune, Machiko Kyô, Masayuki Mori, Takashi Shimura",
+        "Plot": "A heinous crime and its aftermath are recalled from differing points of view.",
+        "Poster": "http://ia.media-imdb.com/images/M/MV5BMjEzMzA4NDE2OF5BMl5BanBnXkFtZTcwNTc5MDI2NQ@@._V1_SX300.jpg",
+        "imdbRating": "8.4",
+        "imdbVotes": "69,263",
+        "imdbID": "tt0042876",
+        "Type": "movie",
+        "Response": "True"
+      },
+      "score": 0.3665771186351776
+    }
+  ],
+  "total_count": 1,
+  "count": 1
+}

data/spec/support/pseudo_orchestrate.io.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+require 'sinatra/base'
+
+class PseudoOrchestrateIo < Sinatra::Base
+
+  # == KeyValue
+
+  # PUT /:version/:collection/:key
+  put "/:version/:collection/:key" do
+    json_response 201
+  end
+
+  # GET /:version/:collection/:key
+  get "/:version/:collection/:key" do
+    json_response 200, "get_values_by_key.json"
+  end
+
+  # DELETE /:version/:collection/:key
+  delete "/:version/:collection/:key" do
+    json_response 204
+  end
+
+  # == Search
+
+  # GET /:version/:collection
+  get "/:version/:collection" do
+    json_response 200, "search_collection.json"
+  end
+
+  # == Events
+
+  # PUT /:version/:collection/:key/events/:type
+  put "/:version/:collection/:key/events/:type" do
+    json_response 201
+  end
+
+  # GET /:version/:collection/:key/events/:type
+  get "/:version/:collection/:key/events/:type" do
+    json_response 200, "get_events_by_key.json"
+  end
+
+  # == Graph
+
+  # PUT /:version/:collection/:key/relations/:relation
+  put "/:version/:collection/:key/relations/:relation/:to_collection/:to_key" do
+    json_response 201
+  end
+
+  # GET /:version/:collection/:key/relations/:relation
+  get "/:version/:collection/:key/relations/:relation" do
+    json_response 200, "get_graph.json"
+  end
+
+private
+
+  def json_response(response_code, filename="")
+    content_type  :json
+    status        response_code
+    File.open(File.join(File.dirname(__FILE__), 'fixtures', filename), 'rb').read unless filename.empty?
+  end
+end