orchestrate 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ba0193a1085b054d2ebb2e472e746a377b785bd
-  data.tar.gz: 41d3c58e1d7959c33fdfdb3b4bb6d86d8aa1d554
+  metadata.gz: 7ea84118d96674889b76ea3cad03c131e6339aa5
+  data.tar.gz: d3c664b057f0af8e147060413ab9a43d96b2ae9f
 SHA512:
-  metadata.gz: 2b6857d31ce13850286561cdfab4c144af59083ad0f26d8a9a1349c633a99453720a6f4f091e72521467b0fc5efa628b4a65aeec95483021789889c8dd96ba58
-  data.tar.gz: 1fdddf125332d0bfeb2bd84b42b772df0b7a770bf757812ca61a3301927a5970e2f042540be55a1778ec3f30ffee23d8dec653f2631db69c8f4832d903536e2c
+  metadata.gz: 7eb7729c1590a618715870997959990b8d4ac057ab240eb15109d704cb3277ad146c1b92de958c3a6259ce56656b0f1fd273ea86e0b32b4bbec734aa8381ad1e
+  data.tar.gz: 8a01ed2702ec401ec9d88628e2b2005a6c1511af13bf0596d051c934d7165e95ac19a00a4c27685b8a1a9bff8832e93bd91a94198f2daec14d802a680cef2afb

data/README.md

@@ -18,6 +18,15 @@ app = Orchestrate::Application.new(api_key)
 users = app[:users]
 ```
 
+#### Changing Data centers
+
+By default, the host data center is AWS US East (https://api.orchestrate.io). To use another data center, such as AWS EU West, then you must initialize the client with the host URL http://api.aws-eu-west-1.orchestrate.io/.
+
+```ruby
+host = "https://api.aws-eu-west-1.orchestrate.io/"
+app = Orchestrate::Application.new(api_key, host)
+```
+
 #### Store some KeyValues, List them
 ```ruby
 users[:joe] = { "name" => "Joe" }           # PUTs joe, returns the input, as per Ruby convention on #[]=
@@ -36,12 +45,34 @@ jill.value                                  # { "name" => "Jill", "location" =>
 jill.save                                   # PUT-If-Match, updates ref
 ```
 
+#### Searching, Sorting for KeyValues
+```ruby
+users.search("name:Jill")                    # returns users with name "Jill"
+users.search("name:Jill").order(:created_at) # returns users with name "Jill" in ascending order
+```
+
+The `order` method accepts multiple arguments, allowing you to sort search results based multiple parameters. When providing multiple field names to sort by each even-numbered argument must be either `:asc` or `:desc`.
+
+```ruby
+users.search("location: Portland").order(:name, :asc, :rank, :desc)
+```
+
+By default, odd-numbered arguments will be sorted in ascending order.
+```ruby
+users.search("location: Portland").order(:name) # returns users in ascending order by name
+users.search("location: Portland").order(:name, :asc, :rank, :desc, :created_at) # :created_at argument defaults to :asc
+```
+
 ### Method Client use
 
 #### Create a Client
 ``` ruby
 # method client
 client = Orchestrate::Client.new(api_key)
+
+# EU data center
+host = "https://api.aws-eu-west-1.orchestrate.io/"
+client = Orchestrate::Client.new(api_key, host)
 ```
 
 #### Query Collections, Keys and Values
@@ -53,6 +84,18 @@ client.delete(:users, :jack, jack.ref)      # DELETE-If-Match, returns API::Resp
 client.list(:users)                         # LIST users, returns API::CollectionResposne
 ```
 
+#### Search Collections
+```ruby
+client.search(:users, "location:Portland") # search 'users' collection for items with a location of 'Portland'
+```
+
+#### Sorting Collections
+```ruby
+client.search(:users, "location:Portland", { sort: "value.name:desc" }) # returns items sorted by a field name in descending order
+client.search(:users, "location:Portland", { sort: "value.name:asc" }) # returns items sorted by a field name in ascending order
+client.search(:users, "location:Portland", { sort: "value.name.last:asc,value.name.first:asc" }) # returns items sorted primarily by last name, but whenever two users have an identical last name, the results will be sorted by first name as well.
+```
+
 ### Examples and Documentation
 
 There are more examples at [Orchestrate's API Documentation][apidoc] and documentation in the [rdoc][].
@@ -157,6 +200,10 @@ end
 
 ## Release Notes
 
+### November 19, 2014: release 0.9.2
+  - Implement `SearchResults#order`, allowing `Collection` object results to be sorted.
+  - Implement Data Center choice on `Orchestrate::Client` and `Orchestrate::Application`.
+
 ### October 8, 2014: release 0.9.1
   - Improvements to documentation.
 

data/lib/orchestrate/application.rb

@@ -6,6 +6,9 @@ module Orchestrate
     # @return [String] The API key provided
     attr_reader :api_key
 
+    # @return [String] The Orchestrate data center URL
+    attr_reader :host
+
     # @return [Orchestrate::Client] The client tied to this application.
     attr_reader :client
 
@@ -13,13 +16,15 @@ module Orchestrate
     # @param client_or_api_key [Orchestrate::Client, #to_s] A client instantiated with the API key and faraday setup, or the API key for your Orchestrate Application.
     # @yieldparam [Faraday::Connection] connection Setup for the Faraday connection.
     # @return Orchestrate::Application
-    def initialize(client_or_api_key, &client_setup)
+    def initialize(client_or_api_key, host="https://api.orchestrate.io", &client_setup)
       if client_or_api_key.kind_of?(Orchestrate::Client)
         @client = client_or_api_key
         @api_key = client.api_key
+        @host = client.host
       else
         @api_key = client_or_api_key
-        @client = Client.new(api_key, &client_setup)
+        @host = host
+        @client = Client.new(api_key, host, &client_setup)
       end
       client.ping
     end

data/lib/orchestrate/client.rb

@@ -10,6 +10,9 @@ module Orchestrate
     # @return [String] The API key provided
     attr_reader :api_key
 
+    # @return [String] The Orchestrate data center URL
+    attr_reader :host
+
     # @return [Faraday::Connection] The Faraday HTTP connection.
     attr_reader :http
 
@@ -18,13 +21,15 @@ module Orchestrate
 
     # Instantiate a new Client for an Orchestrate application.
     # @param api_key [#to_s] The API Key for your Orchestrate application.
+    # @param host [#to_s] The host datacenter for your Orchestrate application.
     # @yieldparam [Faraday::Connection] The setup for the faraday connection.
     # @return Orchestrate::Client
     # @todo api_key -> app_url, parse api_key from auth section of url
-    def initialize(api_key, &block)
+    def initialize(api_key, host="https://api.orchestrate.io", &block)
       @api_key = api_key
+      @host = host
       @faraday_configuration = block
-      @http = Faraday.new("https://api.orchestrate.io") do |faraday|
+      @http = Faraday.new(@host) do |faraday|
         block = lambda{|f| f.adapter :net_http_persistent } unless block
         block.call faraday
 
@@ -131,7 +136,7 @@ module Orchestrate
     # @param collection [#to_s] The name of the collection.
     # @param key [#to_s] The name of the key.
     # @param body [#to_json] The value for the key.
-    # @param condition [String, false, nil] Conditions for setting the value. 
+    # @param condition [String, false, nil] Conditions for setting the value.
     #   If `String`, value used as `If-Match`, value will only be updated if key's current value's ref matches.
     #   If `false`, uses `If-None-Match` the value will only be set if there is no existent value for the key.
     #   If `nil` (default), value is set regardless.

data/lib/orchestrate/collection.rb

@@ -364,6 +364,9 @@ module Orchestrate
 
       # @return [#to_s] The Lucene Query String given as the search query.
       attr_reader :query
+      
+      # @return [#to_s] The sorting parameters.
+      attr_reader :sort
 
       # @return [Integer] The number of results to fetch per request.
       attr_reader :limit
@@ -371,12 +374,24 @@ module Orchestrate
       # Initialize a new SearchResults object
       # @param collection [Orchestrate::Collection] The collection to search.
       # @param query [#to_s] The Lucene Query to perform.
-      def initialize(collection, query)
+      def initialize(collection, query, sort=nil)
         @collection = collection
         @query = query
+        @sort = sort
         @limit = 100
         @offset= nil
       end
+      
+      # Sets the sorting parameters for enumeration over the SearchResults items in the collection.
+      # #order takes multiple arguments, but each even numbered argument must be either :asc or :desc
+      # When given a single argument #order defaults to :asc
+      # @example
+      #  @app[:items].search("location: Portland").order(:name, :asc, :rank, :desc, :created_at)
+      # the :created_at parameter will default to :asc
+      def order(*args)
+        sort = args.each_slice(2).map {|field, dir| dir ||= :asc; "#{field}:#{dir}" }.join(",")
+        self.class.new(collection, query, sort)
+      end
 
       include Enumerable
 
@@ -393,6 +408,7 @@ module Orchestrate
       def each
         params = {limit:limit}
         params[:offset] = offset if offset
+        params[:sort] = sort if sort
         @response ||= collection.perform(:search, query, params)
         return enum_for(:each) unless block_given?
         raise ResultsNotReady.new if collection.app.inside_parallel?

data/lib/orchestrate/version.rb

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

data/test/orchestrate/application_test.rb

@@ -19,6 +19,24 @@ class ApplicationTest < MiniTest::Unit::TestCase
     assert pinged, "API wasn't pinged"
   end
 
+  def test_instantianes_with_api_key_and_host
+    stubs = Faraday::Adapter::Test::Stubs.new
+    pinged = false
+    stubs.head('/v0') do |env|
+      pinged = true
+      [200, response_headers, '']
+    end
+    host = "https://example.com"
+    app = Orchestrate::Application.new("api_key", host) do |conn|
+      conn.adapter :test, stubs
+    end
+
+    assert_equal host, app.host
+    assert_equal "api_key", app.api_key
+    assert_kind_of Orchestrate::Client, app.client
+    assert pinged, "API wasn't pinged"
+  end
+
   def test_instantiates_with_client
     client, stubs = make_client_and_artifacts
     pinged = false
@@ -33,6 +51,21 @@ class ApplicationTest < MiniTest::Unit::TestCase
     assert pinged, "API wasn't pinged"
   end
 
+  def test_instantiates_with_client_and_host
+    client, stubs = make_client_and_artifacts
+    pinged = false
+    stubs.head('/v0') do |env|
+      pinged = true
+      [ 200, response_headers, '' ]
+    end
+    host = 'https://example.com'
+    app = Orchestrate::Application.new(client, host)
+    assert_equal client.host, app.host
+    assert_equal client.api_key, app.api_key
+    assert_equal client, app.client
+    assert pinged, "API wasn't pinged"
+  end
+
   def test_collection_accessor
     app, stubs = make_application
     users = app[:users]

data/test/orchestrate/client_test.rb

@@ -3,6 +3,9 @@ require "test_helper"
 class ClientTest < MiniTest::Unit::TestCase
 
   def test_initialization
+    host = 'https://example.com'
+    client = Orchestrate::Client.new('8c3', host)
+    assert_equal host, client.host
     client = Orchestrate::Client.new('8c3')
     assert_equal '8c3', client.api_key
   end

data/test/orchestrate/collection_sorting_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+
+class CollectionSortingTest < MiniTest::Unit::TestCase
+  def setup
+    @app, @stubs = make_application({parallel:true})
+    @items = @app[:items]
+
+    @query = "foo"
+    @limit = 100
+    @total = 110
+
+    @make_listing = lambda{|i| make_kv_listing(:items, key: "item-#{i}", reftime: nil, score: @total-i/@total*5.0, rank: @total-i/@total*2.0 )}
+    @handle_offset = lambda do |offset|
+      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"}
+      when "100"
+        { "results" => 10.times.map{|i| @make_listing.call(i+100)}, "count" => 10, "total_count" => @total }
+      else
+        raise ArgumentError.new("unexpected offset: #{env.params['offset']}")
+      end
+    end
+
+    @called = false
+    @stubs.get("/v0/items") do |env|
+      @called = true
+      assert_equal @query, env.params['query']
+      assert_equal @limit, env.params['limit'].to_i
+      body = @handle_offset.call(env.params['offset'])
+      [ 200, response_headers, body.to_json ]
+    end
+  end
+
+  def test_basic_sort_ascending
+    results = @items.search("foo").order(:score, :asc).map{|i| i }
+    assert_equal 110, results.length
+    results.each_with_index do |item, idx|
+      assert_in_delta (@total-idx/@total * 5.0), item[0], 0.005
+      assert_equal "item-#{idx}", item[1].key
+      assert_equal @total-idx/@total*5.0, item["score".to_i]
+      assert_nil item[1].reftime
+    end
+  end
+
+  def test_basic_sort_descending
+    results = @items.search("foo").order(:score, :desc).map{|i| i }
+    assert_equal 110, results.length
+    results.each_with_index do |item, idx|
+      assert_in_delta (@total-idx/@total * 5.0), item[0], 0.005
+      assert_equal "item-#{idx}", item[1].key
+      assert_equal @total-idx/@total*5.0, item["score".to_i]
+      assert_nil item[1].reftime
+    end
+  end
+
+  def test_basic_multiple_fields_sort_ascending
+    results = @items.search("foo").order(:score, :asc, :rank, :asc).map{|i| i }
+    assert_equal 110, results.length
+    results.each_with_index do |item, idx|
+      assert_in_delta (@total-idx/@total * 5.0), item[0], 0.005
+      assert_equal "item-#{idx}", item[1].key
+      assert_equal @total-idx/@total*5.0, item["score".to_i]
+      assert_equal @total-idx/@total*2.0, item["rank".to_i]
+      assert_nil item[1].reftime
+    end
+  end
+
+  def test_basic_multiple_fields_sort_descending
+    results = @items.search("foo").order(:score, :asc, :rank, :desc).map{|i| i }
+    assert_equal 110, results.length
+    results.each_with_index do |item, idx|
+      assert_in_delta (@total-idx/@total * 5.0), item[0], 0.005
+      assert_equal "item-#{idx}", item[1].key
+      assert_equal @total-idx/@total*5.0, item["score".to_i]
+      assert_equal @total-idx/@total*2.0, item["rank".to_i]
+      assert_nil item[1].reftime
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Matthew Lyon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,6 +152,7 @@ files:
 - test/orchestrate/collection_enumeration_test.rb
 - test/orchestrate/collection_kv_accessors_test.rb
 - test/orchestrate/collection_searching_test.rb
+- test/orchestrate/collection_sorting_test.rb
 - test/orchestrate/collection_test.rb
 - test/orchestrate/event_enumeration_test.rb
 - test/orchestrate/event_test.rb
@@ -196,6 +197,7 @@ test_files:
 - test/orchestrate/collection_enumeration_test.rb
 - test/orchestrate/collection_kv_accessors_test.rb
 - test/orchestrate/collection_searching_test.rb
+- test/orchestrate/collection_sorting_test.rb
 - test/orchestrate/collection_test.rb
 - test/orchestrate/event_enumeration_test.rb
 - test/orchestrate/event_test.rb