orchestrate 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0d0f4b8f59826a8f9dbba17f58a94d74a56051
-  data.tar.gz: 43ad3fb8c92dddd44e4f4757b94b57c48a142f06
+  metadata.gz: ce3fe8f2f327ee80634c2a1cf9ee17a468db30eb
+  data.tar.gz: 671ec20412081c443941b6f4ab07e26ba2086d12
 SHA512:
-  metadata.gz: 7e114a8889c720f8cb505c39fa32e5526f7ad8e47f60cb6acbacd9175e963692c1d2f19cf07388c5482d2098e67e6a44d21b0fc78afe8adb18e22b1d1e342b03
-  data.tar.gz: bd4bb4b0a7720b99a906247f6e8eb7d8ec1dfd7516cc7996418e6a09912f0ab435c9e66f6a683967f0ee0b9f553142f6fd8b028876c3ce83e9c50f50b5090960
+  metadata.gz: 6f1b8460ad20f8b779e738374b5276c4ee0af7e415826d8a57a37769313430f565c436c2f48a0a00ead3794a20aa5a1b8307dd566de772efd0d48afa62e0ebc7
+  data.tar.gz: 39d65b0dba9b87decc41f1e9107b6bc352935ce81fb38873c8ed8aced33aa8170754fca34a2421eb3be7caabca0cb4d87c72eb3a96e7363bf4875b076ce6bf43

data/README.md

@@ -4,7 +4,7 @@ Orchestrate API for Ruby
 
 Ruby client interface for the [Orchestrate.io](http://orchestrate.io) REST API.
 
-[rDoc Documentation](http://rdoc.info/gems/orchestrate/frames)
+[rDoc Documentation](http://rdoc.info/gems/orchestrate)
 
 ## Getting Started
 
@@ -140,6 +140,21 @@ products.search("*").aggregate  # Start the search query and aggregate param bui
   .each_aggregate               # return enumerator for iterating over each aggregate result
 ```
 
+### Events
+```ruby
+steve = users['Steve']
+
+# create new events
+steve.events['wall_post'] << { text: "Hello!" }
+steve.events['activities'] << { text: "first post" }
+
+# search for events
+users.search('first post').kinds('event').find
+
+# search for 'wall_post' events
+users.search('Hello').kinds('event').types('wall_post').find
+```
+
 ### Method Client use
 
 #### Create a Client
@@ -310,9 +325,10 @@ response.aggregates     # return aggregate results
 
 ### Examples and Documentation
 
-There are more examples at [Orchestrate's API Documentation][apidoc] and documentation in the [rdoc][].
+There are more examples and documentation in [Orchestrate's API Documentation][apidoc] and the [rdoc][rdoc].
 
 [apidoc]: http://orchestrate.io/api/version
+[rdoc]: http://rdoc.info/gems/orchestrate
 
 ## Swapping out the HTTP back end
 
@@ -412,6 +428,10 @@ end
 
 ## Release Notes
 
+### March 27, 2015: release 0.11.2
+  - Implement `Orchestrate::Search::QueryBuilder#kinds` to search events as well as KV items.
+  - Implement `Orchestrate::Search::QueryBuilder#types` to search specific types of events.
+
 ### February 17, 2015: release 0.11.1
   - Implement `Search::TimeSeriesBuilder#time_zone` to designate time zone when calculating time series bucket boundaries.
 
@@ -419,7 +439,7 @@ end
   - **BACKWARDS-INCOMPATIBLE** `Orchestrate::Collection` searches require `#find` method at the end of the method call/chain. Example: `users.search('foo').find`.
   - Implement `Orchestrate::Search` module, refactor functionality of prior `Orchestrate::Collection::SearchResults`.
   - Implement results enumeration & request firing functionality in prior `Orchestrate::Collection::SearchResults` to `Orchestrate::Search::Results`
-  - Implement `Search::QueryBuilder` to construct `Collection` search queries. 
+  - Implement `Search::QueryBuilder` to construct `Collection` search queries.
   - Implement `Search::AggregateBuilder` to construct aggregate params on `Collection` search queries.
   - Implement `Search::StatsBuilder`, `Search::RangeBuilder`, `Search::DistanceBuilder`, & `Search::TimeSeriesBuilder` to construct aggregate function clauses for aggregate params.
   - Implement `Search::AggregateResult` objects to repesent aggregate results returned from `Collection` search.

data/lib/orchestrate/event.rb

@@ -23,8 +23,8 @@ module Orchestrate
     def self.from_listing(stem, listing, response=nil)
       event = new(stem)
       event.value = listing['value']
-      event.instance_variable_set(:@timestamp, listing['timestamp'])
-      event.instance_variable_set(:@ordinal, listing['ordinal'])
+      event.instance_variable_set(:@timestamp, listing['path']['timestamp'])
+      event.instance_variable_set(:@ordinal, listing['path']['ordinal'])
       event.instance_variable_set(:@ref, listing['path']['ref'])
       event.instance_variable_set(:@last_request_time, response.request_time) if response
       event

data/lib/orchestrate/search/query_builder.rb

@@ -4,15 +4,22 @@ module Orchestrate::Search
     # @return [Collection] The collection this object will search.
     attr_reader :collection
 
-    # @return [#to_s] The Lucene Query String given as the search query.
-    attr_reader :query
-
     # Initialize a new SearchBuilder object
     # @param collection [Orchestrate::Collection] The collection to search.
     # @param query [#to_s] The Lucene Query to perform.
     def initialize(collection, query)
       @collection = collection
       @query = query
+      @kinds = []
+      @types = []
+    end
+
+    # @return [#to_s] The Lucene Query String.
+    def query
+      query = "(#{@query})"
+      query << " AND @path.kind:(#{@kinds.join(' ')})" if @kinds.any?
+      query << " AND @path.type:(#{@types.join(' ')})" if @types.any?
+      query
     end
 
     # @return Pretty-Printed string representation of the Search object
@@ -37,7 +44,7 @@ module Orchestrate::Search
       self
     end
 
-    # Sets the limit for the query to Orchestrate, so we don't ask for more than is needed. 
+    # Sets the limit for the query to Orchestrate, so we don't ask for more than is needed.
     # Does not fire a request.
     # @overload limit
     #   @return [Integer, nil] The number of items to retrieve.  Nil is equivalent to zero.
@@ -69,6 +76,22 @@ module Orchestrate::Search
       end
     end
 
+    # Sets the 'kind' to search.
+    # @param kinds [Array<String>] The orchestrate kinds to be included ('item' or 'event').
+    # @return [QueryBuilder] self.
+    def kinds(*kinds)
+      @kinds = kinds
+      self
+    end
+
+    # Sets the event types to search.
+    # @param types [Array<String>] The orchestrate event types to search (e.g. 'activities', 'wall_posts')
+    # @return [QueryBuilder] self.
+    def types(*types)
+      @types = types
+      self
+    end
+
     # @return [AggregateBuilder] An AggregateBuilder object to construct aggregate search params
     def aggregate
       options[:aggregate] ||= AggregateBuilder.new(self)
@@ -80,4 +103,4 @@ module Orchestrate::Search
       Results.new(collection, query, options)
     end
   end
-end
+end

data/lib/orchestrate/search/results.rb

@@ -47,7 +47,15 @@ module Orchestrate::Search
       raise Orchestrate::ResultsNotReady.new if collection.app.inside_parallel?
       loop do
         @response.results.each do |listing|
-          yield [ listing['score'], Orchestrate::KeyValue.from_listing(collection, listing, @response) ]
+          case listing['path']['kind']
+          when 'event'
+            kv = collection.stub(listing['key'])
+            event_type = Orchestrate::EventType.new(kv, listing['type'])
+            event = Orchestrate::Event.from_listing(event_type, listing, @response)
+            yield [listing['score'], event]
+          else
+            yield [listing['score'], Orchestrate::KeyValue.from_listing(collection, listing, @response)]
+          end
         end
         break unless @response.next_link
         @response = @response.next_results

data/lib/orchestrate/version.rb

@@ -1,4 +1,4 @@
 module Orchestrate
   # @return [String] The version number of the Orchestrate Gem
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

data/orchestrate.gemspec

@@ -5,8 +5,8 @@ require 'orchestrate/version'
 Gem::Specification.new do |s|
   s.name          = 'orchestrate'
   s.version       = Orchestrate::VERSION
-  s.authors       = ['Matthew Lyon', 'Justin Mecham', 'James Carrasquer', 'Eric Johnson']
-  s.email         = ['matthew@lyonheart.us', 'justin@mecham.me', 'jimcar@aracnet.com', 'erjohnson.pdx@gmail.com']
+  s.authors       = ['Matthew Lyon', 'Justin Mecham', 'James Carrasquer', 'Eric Johnson', 'Daniel Reverri']
+  s.email         = ['matthew@lyonheart.us', 'justin@mecham.me', 'jimcar@aracnet.com', 'erjohnson.pdx@gmail.com', 'reverri@gmail.com']
   s.summary       = 'Ruby client for Orchestrate.io'
   s.description   = 'Client for the Orchestrate REST API'
   s.homepage      = 'https://github.com/orchestrate-io/orchestrate-ruby'
@@ -24,4 +24,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency "typhoeus"
   s.add_development_dependency "em-http-request"
   s.add_development_dependency "em-synchrony"
-end
+end

data/test/orchestrate/collection_aggregates_test.rb

@@ -5,7 +5,7 @@ class CollectionAggregates < MiniTest::Unit::TestCase
     @app, @stubs = make_application({parallel:true})
     @items = @app[:items]
 
-    @query = "foo"
+    @query = '(foo)'
     @stats = [{
       "aggregate_kind" => "stats",
       "field_name" => "value.bar",
@@ -109,7 +109,7 @@ class CollectionAggregates < MiniTest::Unit::TestCase
   end
 
   def test_basic_distance_aggregate
-    @query = "foo:NEAR:{lat:12.3 lon:56.7 dist:100km}"
+    @query = "(foo:NEAR:{lat:12.3 lon:56.7 dist:100km})"
     results = @items.near("foo", 12.3, 56.7, 100).aggregate.distance("bar").between(0,1).find
     results.each_aggregate
     assert_equal @distance, results.aggregates

data/test/orchestrate/collection_geo_queries_test.rb

@@ -5,21 +5,21 @@ class CollectionGeoQueriesTest < MiniTest::Unit::TestCase
     @app, @stubs = make_application({parallel:true})
     @items = @app[:items]
 
-    @near_query = "location:NEAR:{lat:12 lon:56 dist:1km}"
-    @in_query = "location:IN:{north:12 east:57 south:12 west:56}"
+    @near_query = "(location:NEAR:{lat:12 lon:56 dist:1km})"
+    @in_query = "(location:IN:{north:12 east:57 south:12 west:56})"
     @total = 110
 
     @make_listing = lambda{|i| make_kv_listing(:items, key: "item-#{i}", reftime: nil, score: @total-i/@total*5.0) }
     @handle_geo = lambda do |query|
       case query
-      when "location:NEAR:{lat:12 lon:56 dist:1km}"
+      when "(location:NEAR:{lat:12 lon:56 dist:1km})"
         { "results" => 10.times.map{|i| @make_listing.call(i)}, "count" => 10, "total_count" => 10 }
-      when "location:IN:{north:12 east:57 south:12 west:56}"
+      when "(location:IN:{north:12 east:57 south:12 west:56})"
         { "results" => 12.times.map{|i| @make_listing.call(i)}, "count" => 12, "total_count" => 12 }
-      when "location:NEAR:{lat:12 lon:56 dist:1km}&sort=location:distance:asc"
+      when "(location:NEAR:{lat:12 lon:56 dist:1km}&sort=location:distance:asc)"
         { "results" => 10.times.map{|i| @make_listing.call(i)}, "count" => 10, "total_count" => 10 }
       else
-        raise ArgumentError.new("unexpected query: #{env.params['query']}")
+        raise ArgumentError.new("unexpected query: #{query}")
       end
     end
 
@@ -86,4 +86,4 @@ class CollectionGeoQueriesTest < MiniTest::Unit::TestCase
       assert_nil item[1].reftime
     end
   end
-end
+end

data/test/orchestrate/collection_searching_test.rb

@@ -1,11 +1,12 @@
-require "test_helper"
+require 'test_helper'
+require 'cgi'
 
 class CollectionSearchingTest < MiniTest::Unit::TestCase
   def setup
     @app, @stubs = make_application({parallel:true})
     @items = @app[:items]
 
-    @query = "foo"
+    @query = '(foo)'
     @limit = 100
     @total = 110
 
@@ -14,7 +15,7 @@ class CollectionSearchingTest < MiniTest::Unit::TestCase
       case offset
       when nil
         { "results" => 100.times.map{|i| @make_listing.call(i)}, "count" => 100, "total_count" => @total,
-          "next" => "/v0/items?query=foo&offset=100&limit=100"}
+          "next" => "/v0/items?query=#{CGI.escape(@query)}&offset=100&limit=100"}
       when "100"
         { "results" => 10.times.map{|i| @make_listing.call(i+100)}, "count" => 10, "total_count" => @total }
       else
@@ -97,4 +98,55 @@ class CollectionSearchingTest < MiniTest::Unit::TestCase
     assert_equal @total, items.force.size
   end
 
+  def test_search_with_events
+    body = '{
+    "count": 2,
+    "total_count": 2,
+    "results": [
+      {
+        "path": {
+          "collection": "users",
+          "kind": "item",
+          "key": "sjkaliski@gmail.com",
+          "ref": "74c22b1736b9d50e",
+          "reftime": 1424473968410
+        },
+        "value": {
+          "name": "Steve Kaliski",
+          "hometown": "New York, NY",
+          "twitter": "@stevekaliski"
+        },
+        "score": 3.7323708534240723,
+        "reftime": 1424473968410
+      },
+      {
+        "path": {
+          "collection": "users",
+          "kind": "event",
+          "key": "byrd@bowery.io",
+          "type": "activities",
+          "timestamp": 1412787145997,
+          "ordinal": 406893558185357300,
+          "ref": "82eafab14dc84ed3",
+          "reftime": 1412787145997,
+          "ordinal_str": "05a593890d087000"
+        },
+        "value": {
+          "activity": "followed",
+          "user": "sjkaliski@gmail.com",
+          "userName": "Steve Kaliski"
+        },
+        "score": 2.331388473510742,
+        "reftime": 1412787145997
+      }
+    ]
+    }'
+    @stubs.get('/v0/users') do
+      [200, { 'Content-Type' => 'application/json' }, body]
+    end
+    results = @app[:users].search('*').find.each.map { |d| d[1] }
+    assert_equal 2, results.count
+    assert results[0].is_a? Orchestrate::KeyValue
+    assert results[1].is_a? Orchestrate::Event
+  end
 end

data/test/orchestrate/collection_sorting_test.rb

@@ -1,11 +1,12 @@
-require "test_helper"
+require 'test_helper'
+require 'cgi'
 
 class CollectionSortingTest < MiniTest::Unit::TestCase
   def setup
     @app, @stubs = make_application({parallel:true})
     @items = @app[:items]
 
-    @query = "foo"
+    @query = '(foo)'
     @limit = 100
     @total = 110
 
@@ -14,7 +15,7 @@ class CollectionSortingTest < MiniTest::Unit::TestCase
       case offset
       when nil
         { "results" => 100.times.map{|i| @make_listing.call(i)}, "count" => 100, "total_count" => @total,
-          "next" => "/v0/items?query=foo&offset=100&limit=100"}
+          "next" => "/v0/items?query=#{CGI.escape(@query)}&offset=100&limit=100"}
       when "100"
         { "results" => 10.times.map{|i| @make_listing.call(i+100)}, "count" => 10, "total_count" => @total }
       else

data/test/orchestrate/event_test.rb

@@ -240,25 +240,25 @@ class EventTest < MiniTest::Unit::TestCase
     assert_nil tweets <=> bar.events['tweets']
 
     ts = (Time.now.to_f * 1000).floor
-    make_tweet_1 = lambda { Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref}, "timestamp" => ts, "ordinal" => 10}) }
+    make_tweet_1 = lambda { Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref, "timestamp" => ts, "ordinal" => 10}}) }
     tweet1 = make_tweet_1.call
     assert_equal tweet1, make_tweet_1.call
     assert tweet1.eql?(make_tweet_1.call)
     assert_equal 0, tweet1 <=> make_tweet_1.call
 
-    tweet2 = Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref}, "timestamp" => ts, "ordinal" => 11})
+    tweet2 = Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref, "timestamp" => ts, "ordinal" => 11}})
     refute_equal tweet1, tweet2
     refute tweet1.eql?(tweet2)
     assert_equal 1, tweet1 <=> tweet2
     assert_equal(-1, tweet2 <=> tweet1)
 
-    tweet3 = Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref}, "timestamp" => ts - 1, "ordinal" => 2})
+    tweet3 = Orchestrate::Event.from_listing(tweets, {"path" => {"ref" => make_ref, "timestamp" => ts - 1, "ordinal" => 2}})
     assert_equal(1, tweet1 <=> tweet3)
     assert_equal(-1, tweet3 <=> tweet1)
     assert_equal(1, tweet2 <=> tweet3)
     assert_equal(-1, tweet3 <=> tweet2)
 
-    checkin = Orchestrate::Event.from_listing(foo.events[:checkins], {"path" => {"ref" => make_ref}, "timestamp" => ts, "ordinal" => 40})
+    checkin = Orchestrate::Event.from_listing(foo.events[:checkins], {"path" => {"ref" => make_ref, "timestamp" => ts, "ordinal" => 40}})
     refute_equal tweet1, checkin
     refute tweet1.eql?(checkin)
     assert_nil tweet1 <=> checkin

data/test/orchestrate/search/query_builder_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class QueryBuilderTest < MiniTest::Unit::TestCase
+  def setup
+    @builder = Orchestrate::Search::QueryBuilder.new(nil, '*')
+  end
+
+  def test_event_query
+    @builder.kinds('event')
+    assert_equal '(*) AND @path.kind:(event)', @builder.query
+  end
+
+  def test_event_or_item_query
+    @builder.kinds('event', 'item')
+    assert_equal '(*) AND @path.kind:(event item)', @builder.query
+  end
+
+  def test_event_types_query
+    @builder.kinds('event').types('activities')
+    assert_equal '(*) AND @path.kind:(event) AND @path.type:(activities)',
+                 @builder.query
+  end
+end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Matthew Lyon
 - Justin Mecham
 - James Carrasquer
 - Eric Johnson
+- Daniel Reverri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -31,84 +32,84 @@ dependencies:
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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: typhoeus
   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: em-http-request
   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: em-synchrony
   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'
 description: Client for the Orchestrate REST API
@@ -117,13 +118,14 @@ email:
 - justin@mecham.me
 - jimcar@aracnet.com
 - erjohnson.pdx@gmail.com
+- reverri@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
+- .gitignore
+- .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
@@ -168,6 +170,7 @@ files:
 - test/orchestrate/key_value_test.rb
 - test/orchestrate/ref_test.rb
 - test/orchestrate/relations_test.rb
+- test/orchestrate/search/query_builder_test.rb
 - test/test_helper.rb
 homepage: https://github.com/orchestrate-io/orchestrate-ruby
 licenses:
@@ -179,17 +182,17 @@ 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.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby client for Orchestrate.io
@@ -215,4 +218,5 @@ test_files:
 - test/orchestrate/key_value_test.rb
 - test/orchestrate/ref_test.rb
 - test/orchestrate/relations_test.rb
+- test/orchestrate/search/query_builder_test.rb
 - test/test_helper.rb