orchestrate.io 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 030c4576b297c75a43131f0ee77a6480a3ad54de
-  data.tar.gz: 41d62609e2f8f47af724f6c81fdfd55692c8525f
+  metadata.gz: 64d4dc3dcb7ee565eac14b038f92c43d21a774e3
+  data.tar.gz: 46c4c37e165aa91732991565e81fb31d93526c01
 SHA512:
-  metadata.gz: 8112bd88a96b59c3f70d8b466127f0ef128c02fe916269405650250bda8c90fbaece103c97f6e64420d9fdf415c239e80999b3f133cc9895ea9af4d2ad9c6ebe
-  data.tar.gz: 7b62f8740304def1591fbad20dc163a878ed00e75f7df08d291a975681cacd1074029d612b2c2d313565d41e227b100b4d38ffec77b449a9314c43318d17bba0
+  metadata.gz: baaa6949592a3d9976db9a8353015618da3c928b9eed997401f1e282dda17bf1b7c4014e299faf79d1dd35380652eea3c39b8f67497624af12c81356aa434378
+  data.tar.gz: cf657f6f6024c72a3db4a0767d52cbde041edf276ea4eeb658039b47e417336c7b31e9ab641afeff97f831a2ab7bef7c469467870b6728175c346b9959785a74

data/README.md

@@ -28,6 +28,8 @@ $ gem install orchestrate.io
 
 ## Usage
 
+Initializes the `OrchestrateIo` class with your API key to create a new object that you perform the following API calls with.
+
 ```
 require 'orchestrate.io'
 require 'json'
@@ -37,7 +39,36 @@ require 'json'
 @search_query = "hello dolly"
 ```
 
-#### Key/Value
+### Collections
+
+##### DELETE
+Deletes an entire collection.
+
+> under development
+
+```
+@io.collection :delete do
+  collection "foo"
+  force       true
+end.perform
+```
+
+### Key/Value
+
+##### GET
+Gets the latest value assigned to a key.
+
+```
+@io.key_value :get do
+  collection "foo"
+  key        "bar"
+end.perform
+```
+
+##### PUT
+Creates or updates the value at the collection/key specified.
+
+`NOTE`: You can create a new collection by performing a Key/Value PUT to the collection.
 
 ```
 @io.key_value :put do
@@ -45,14 +76,21 @@ require 'json'
   key        "bar"
   data        @json_data
 end.perform
+```
 
-@io.key_value :get do
+##### DELETE
+Sets the value of a key to a null object.
+
+```
+@io.key_value :delete do
   collection "foo"
   key        "bar"
 end.perform
 ```
 
-#### Search
+### Search
+
+Returns list of items matching the lucene query.
 
 ```
 @io.search :get do
@@ -61,27 +99,49 @@ end.perform
 end.perform
 ```
 
-#### Events
+### Events
+
+##### GET
+Returns a list of events, optionally limited to specified time range in reverse chronological order.
 
 ```
-@io.events :put do
+@io.event :get do
   collection "foo"
   key        "bar"
   type       "log"
-  data        @json_data
-　timestamp   1384224213
+　from        1384224210
+　to          1384224213
 end.perform
+```
 
-@io.events :get do
+##### PUT
+Puts an event with an optional user defined timestamp.
+
+```
+@io.event :put do
   collection "foo"
   key        "bar"
   type       "log"
-　from        1384224210
-　to          1384224213
+  data        @json_data
+　timestamp   1384224213
+end.perform
+```
+
+### Graph
+
+##### GET
+Returns relation’s collection, key, ref, and values.
+
+```
+@io.graph :get do
+  collection "foo"
+  key        "bar1"
+  relation   "friends"
 end.perform
 ```
 
-#### Graph
+##### PUT
+Creates a relationship between two objects. Relations can span collections.
 
 ```
 @io.graph :put do
@@ -91,12 +151,6 @@ end.perform
   to_collection "hoge"
   to_key        "bar2"
 end.perform
-
-@io.graph :get do
-  collection "foo"
-  key        "bar1"
-  relation   "friends"
-end.perform
 ```
 
 ## Contributing

data/lib/orchestrate.io/client.rb

@@ -2,9 +2,10 @@
 require 'httparty'
 require 'orchestrate.io/helper'
 require 'orchestrate.io/configuration'
+require 'orchestrate.io/collection'
 require 'orchestrate.io/key_value'
 require 'orchestrate.io/search'
-require 'orchestrate.io/events'
+require 'orchestrate.io/event'
 require 'orchestrate.io/graph'
 require 'orchestrate.io/request'
 

data/lib/orchestrate.io/collection.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class Collection
+
+    attr_reader :request
+
+    # == Usage
+    #
+    # io = OrchestrateIo.new(api_key: "abc")
+    # request = io.collection :delete do
+    #   collection  'films'
+    #   key         'the_godfather'
+    # end
+    #
+    # request.perform
+    # #=> HTTParty::Response
+    #
+    def initialize(client, method, &block)
+      args = {
+        client: client,
+        http_method: method,
+        uri: uri,
+        options: options
+      }
+
+      @request = OrchestrateIo::Request.new(args, &block)
+    end
+
+    def perform
+      request.perform
+    end
+
+  protected
+
+    def uri
+      "/:version/:collection"
+    end
+
+    def options
+      options = {}
+      options[:query] = { force: :force }
+      options
+    end
+  end
+end

data/lib/orchestrate.io/{events.rb → event.rb}

@@ -1,14 +1,14 @@
 # encoding: utf-8
 
 module OrchestrateIo
-  class Events
+  class Event
 
     attr_reader :request
 
     # == Usage
     #
     # io = OrchestrateIo.new(api_key: "abc")
-    # request = io.events :get do
+    # request = io.event :get do
     #   collection  'films'
     #   key         'the_godfather'
     #   type        'comments'

data/lib/orchestrate.io/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module OrchestrateIo
-  Version = VERSION = "0.1.4"
+  Version = VERSION = "0.1.5"
 end

data/spec/orchestrate.io/client_spec.rb

@@ -74,16 +74,16 @@ describe OrchestrateIo::Client do
       end
     end
 
-    context '#events' do
+    context '#event' do
       it 'creates a new event instance' do
         request_data = '{ "User": "peter_bradshaw", "Text": "A measured, deathly serious epic." }'
         expect(
-          client.events(:get){
+          client.event(:get){
             collection  "films"
             key         "the_godfather"
             type        "comments"
           }
-        ).to be_an_instance_of OrchestrateIo::Events
+        ).to be_an_instance_of OrchestrateIo::Event
       end
     end
 

data/spec/orchestrate.io/collection_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe OrchestrateIo::Collection do
+  let(:client) { OrchestrateIo.new(api_key: 'abc') }
+
+  describe "DELETE /:version/:collection" do
+    let(:request) {
+      client.collection :delete do
+        collection "films"
+        force       true
+      end
+    }
+
+    it "performs a request with the correct options" do
+      client.should_receive(:request).
+        with(:delete, "/v0/films", {:query=>{:force=>true}})
+      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/events_spec.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe OrchestrateIo::Events do
+describe OrchestrateIo::Event do
   let(:client) { OrchestrateIo.new(api_key: 'abc') }
 
   describe "PUT /:version/:collection/:key/events/:type" do
     let(:request) {
-      client.events :put do
+      client.event :put do
         collection "films"
         key        "the_godfather"
         type       "comments"
@@ -30,7 +30,7 @@ describe OrchestrateIo::Events do
 
   describe "GET /:version/:collection/:key/events/:type" do
     let(:request) {
-      client.events :get do
+      client.event :get do
         collection  "films"
         key         "the_godfather"
         type        "comments"

data/spec/support/pseudo_orchestrate.io.rb

@@ -3,6 +3,13 @@ require 'sinatra/base'
 
 class PseudoOrchestrateIo < Sinatra::Base
 
+  # == Collection
+
+  # DELETE /:version/:collection
+  delete "/:version/:collection" do
+    json_response 204
+  end
+
   # == KeyValue
 
   # PUT /:version/:collection/:key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate.io
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - azukiwasher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -184,10 +184,11 @@ files:
 - bin/orchestrate.io
 - lib/orchestrate.io.rb
 - lib/orchestrate.io/client.rb
+- lib/orchestrate.io/collection.rb
 - lib/orchestrate.io/configuration.rb
 - lib/orchestrate.io/core_ext.rb
 - lib/orchestrate.io/core_ext/string.rb
-- lib/orchestrate.io/events.rb
+- lib/orchestrate.io/event.rb
 - lib/orchestrate.io/graph.rb
 - lib/orchestrate.io/helper.rb
 - lib/orchestrate.io/key_value.rb
@@ -197,6 +198,7 @@ files:
 - lib/orchestrate.io/version.rb
 - orchestrate.io.gemspec
 - spec/orchestrate.io/client_spec.rb
+- spec/orchestrate.io/collection_spec.rb
 - spec/orchestrate.io/core_ext/string_spec.rb
 - spec/orchestrate.io/events_spec.rb
 - spec/orchestrate.io/graph_spec.rb
@@ -237,6 +239,7 @@ specification_version: 4
 summary: A Ruby wrapper for the Orchestrate.io API.
 test_files:
 - spec/orchestrate.io/client_spec.rb
+- spec/orchestrate.io/collection_spec.rb
 - spec/orchestrate.io/core_ext/string_spec.rb
 - spec/orchestrate.io/events_spec.rb
 - spec/orchestrate.io/graph_spec.rb