usergrid_iron 0.0.2 → 0.0.3

data/.rvmrc

@@ -1,2 +1,2 @@
 rvm_gemset_create_on_use_flag=1
-rvm gemset use 'usergrid'
+rvm gemset use 'usergrid_iron'

data/README.md

@@ -1,8 +1,7 @@
 # Usergrid_iron
 
-Usergrid_iron enables simple, low-level Ruby access to Apigee's App Services (aka Usergrid) REST API with minimal
-dependencies.
-
+Usergrid_iron enables simple, low-level Ruby access to Apigee's App Services (aka Usergrid)
+REST API with minimal dependencies.
 
 ## Installation
 
@@ -21,16 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-1. Not familiar with Usergrid / Apigee's App Services? It's great stuff! Check it out, here:
+### Not familiar with Usergrid / Apigee's App Services?
+
+#### It's great stuff! Check it out, here:
+
+  Docs: <http://apigee.com/docs/usergrid/>  
+  Open source: <https://github.com/apigee/usergrid-stack>
 
-Docs: http://apigee.com/docs/usergrid/
-Open source: https://github.com/apigee/usergrid-stack
+### Getting started with the Usergrid_iron SDK is simple! 
 
-2. Getting started with the Usergrid_iron SDK is simple! Let's start with the basics.
-I'll assume you've already set up an organization, application, and user - just fill in your
-own values in the code below.
+#### Let's start with the basics.
+For this example, we'll assume you've already set up an organization, application, and user -
+just fill in your own values in the code below.
 
-<pre>
+```
 require 'usergrid_iron'
 
 # fill in your values here!
@@ -55,15 +58,18 @@ same_dog = application['dogs'][uuid].entity
 
 # is it our dog? well, he knows his name!
 puts "My dog's name is: #{same_dog.name}"
-</pre>
+```
 
-That was really easy. So let's try something slightly more complex.
-Let's say we've registered for an organization, but we don't have an application yet (or
-want to create a new one to work on). No worries, just fill in your organization and
-superuser credentials below, and follow along! (Better yet: If you used the Usergrid launcher
-and let it initialize your database, you shouldn't need to do anything!)
+Well that was really easy. 
 
-<pre>
+#### Let's try something slightly more complex.
+Let's say you've registered for an organization, but you don't have an application yet
+(or want to create a new one to work on). No worries, just fill in your organization and
+superuser credentials below, and follow along!
+(Better yet: If you used the Usergrid launcher and let it initialize your database,
+you shouldn't need to do anything!)
+
+```
   require 'usergrid_iron'
 
   usergrid_api = 'http://localhost:8080'
@@ -83,7 +89,7 @@ and let it initialize your database, you shouldn't need to do anything!)
   new_application = organization.create_application app_name
 
   # create an user for our application
-  new_application.create_user 'username', 'name', 'email@test.com', 'password'
+  new_application.create_user 'username', 'password'
 
 
   ## now we can play with the puppies! ##
@@ -107,7 +113,7 @@ and let it initialize your database, you shouldn't need to do anything!)
   end
 
   # "Benji, come!"
-  benji = dogs.query("select * where name = 'Benji'").entity  # shortcut: entity will return the first in the collection
+  benji = dogs.query("select * where name = 'Benji'").entity  # shortcut: entity() returns the first
 
   # modify Benji's attributes & save
   benji.location = 'home'                     # use attribute access
@@ -120,7 +126,7 @@ and let it initialize your database, you shouldn't need to do anything!)
     puts "Benji's home!"
   end
 
-</pre>
+```
 
 Whew. That's enough for now. But looking for a specific feature? Check out the rspecs,
 there are examples of nearly everything!
@@ -146,6 +152,23 @@ In order to run the tests, check out the Usergrid open source project
 usergrid_iron/spec/spec_settings.yaml to match.)
 
 
+## Release notes
+
+### 0.0.3 
+* New features
+  1. Support for lists returned when making parameterized queries:
+	 <pre>select username, email where…</pre>
+	 or replacement queries:
+	 <pre>select { user:username, email:email } where…
+* Incompatible changes
+  1. Application.create_user parameter change from:
+     <pre>create_user(username, name, email, password, invite=false)</pre>
+     to:
+     <pre>create_user(username, password, email=nil, name=nil, invite=false)</pre>
+* Backend changes
+  1. Replaced json_pure dependency with multi_json
+
+
 ## Notes
 
 The following features are not currently implemented on the server:
@@ -156,17 +179,16 @@ The following features are not currently implemented on the server:
 
 
 ## Copyright
+Copyright (c) 2012 Scott Ganyo 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use the included files except in compliance with the License.
+
+You may obtain a copy of the License at
 
- * Copyright (c) 2012 Scott Ganyo
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use the included files except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+  <http://www.apache.org/licenses/LICENSE-2.0>
+  
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions and
+limitations under the License.

data/lib/usergrid/core/application.rb

@@ -7,13 +7,13 @@ module Usergrid
       super url, api_url, options
     end
 
-    def create_user(username, name, email, password, invite=false)
-      data = { username: username,
-               name: name,
-               email: email,
-               password: password,
-               invite: invite }
-      create_entity 'users', data
+    def create_user(username, password, email=nil, name=nil, invite=false)
+      user_hash = { username: username,
+                    password: password,
+                    email: email,
+                    name: name,
+                    invite: invite }
+      create_entity 'users', user_hash
     end
 
     # note: collection_name s/b plural!

data/lib/usergrid/core/resource.rb

@@ -78,12 +78,12 @@ module Usergrid
     end
 
     def post(payload, additional_headers={}, &block)
-      payload = payload.to_json if payload.is_a?(Hash) || payload.is_a?(Array)
+      payload = MultiJson.dump(payload) if payload.is_a?(Hash) || payload.is_a?(Array)
       self.response = super payload, additional_headers, &block
     end
 
     def put(payload, additional_headers={}, &block)
-      payload = payload.to_json if payload.is_a?(Hash) || payload.is_a?(Array)
+      payload = MultiJson.dump(payload) if payload.is_a?(Hash) || payload.is_a?(Array)
       self.response = super payload, additional_headers, &block
     end
 

data/lib/usergrid/extensions/response.rb

@@ -10,7 +10,7 @@ module RestClient
     end
 
     def data
-      @data = JSON.parse(self).add_dot_notation! unless @data
+      @data = MultiJson.load(self).add_dot_notation! unless @data
       @data
     end
 
@@ -25,10 +25,10 @@ module RestClient
 
     def entities_data
       return @entities_data if @entities_data
-      entities_data = data['entities'] || data['data'] || data['messages']
+      entities_data = data['entities'] || data['data'] || data['messages'] || data['list']
       raise "unable to determine entities from: #{data}" unless entities_data.is_a?(Array)
       entities_data.each do |e|
-        e['uri'] = resource.concat_urls(data['uri'], e['uuid']) if e['uuid']
+        e['uri'] = resource.concat_urls(data['uri'], e['uuid']) if e.is_a?(Hash) && e['uuid']
       end
       @entities_data = entities_data
     end
@@ -37,7 +37,11 @@ module RestClient
       return @entities if @entities
       index = -1
       @entities = entities_data.collect do |e|
-        Usergrid::Entity.new e['uri'], resource.api_url, resource.options, self, index+=1
+        if e.is_a? Array
+          e
+        else
+          Usergrid::Entity.new e['uri'], resource.api_url, resource.options, self, index+=1
+        end
       end
     end
 

data/lib/usergrid/version.rb

@@ -1,3 +1,3 @@
 module Usergrid
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/lib/usergrid_iron.rb

@@ -1,5 +1,6 @@
 require 'logger'
-require 'json'
+require 'multi_json'
+
 
 module Usergrid
 

data/spec/spec_helper.rb

@@ -29,7 +29,7 @@ begin
                                  SPEC_SETTINGS[:organization][:password])
   LOG.info "created organization with user #{SPEC_SETTINGS[:organization][:username]}@email.com"
 rescue
-  if JSON($!.response)['error'] == "duplicate_unique_property_exists"
+  if MultiJson.load($!.response)['error'] == "duplicate_unique_property_exists"
     LOG.debug "test organization exists"
   else
     raise $!
@@ -62,9 +62,9 @@ end
 def create_random_user(application, login=false)
   random = SecureRandom.hex
   user_hash = {username: "username_#{random}",
-               name:     "#{random} name",
+               password: random,
                email:    "#{random}@email.com",
-               password: random}
+               name:     "#{random} name" }
   entity = application['users'].post(user_hash).entity
   application.login user_hash[:username], user_hash[:password] if login
   entity

data/spec/usergrid/core/application_spec.rb

@@ -10,18 +10,23 @@ describe Usergrid::Application do
     delete_application @application
   end
 
-  it "should be able to create and delete a user" do
+  it "should be able to create, login, and delete a user" do
     random = SecureRandom.hex
-    response = @application.create_user("username_#{random}", "#{random} name", "#{random}@email.com", random)
+    application = Usergrid::Application.new @application.url # create application resource that's not logged in
+    response = application.create_user "username_#{random}", 'password'
     entity = response.entity
+    application.login "username_#{random}", 'password'
     begin
       response.code.should eq 200
       response.entities.size.should eq 1
       entity.uuid.should_not be_nil
-      response = @application["users/#{entity.uuid}"].get
+      response = application["users/#{entity.uuid}"].get
       response.code.should eq 200
     ensure
       entity.delete
+      # deleted user shouldn't be able to access anything now
+      expect { application["users/#{entity.uuid}"].get }.to raise_error(RestClient::Unauthorized)
+      # use original application - logged in under existing user
       expect { @application["users/#{entity.uuid}"].get }.to raise_error(RestClient::ResourceNotFound)
     end
   end

data/spec/usergrid/core/collection_spec.rb

@@ -7,7 +7,7 @@ describe Usergrid::Collection do
     @collection = @application['tests'].collection
     @entity_data = []
     (1..10).each do |i|
-      test = { name: "test_#{i}" }
+      test = { name: "name_#{i}", value: "value_#{i+1}" }
       @entity_data << test
     end
     @collection.create_entities @entity_data
@@ -18,11 +18,29 @@ describe Usergrid::Collection do
     delete_application @application
   end
 
-  it "should be able to query a collection" do
+  it "should be able to do a simple query" do
     @collection.query "select * where name = \'#{@entity_data[0][:name]}\'"
     @collection.size.should eq 1
   end
 
+  it "should be able to select data elements" do
+    @collection.query "select name, value where name = \'#{@entity_data[0][:name]}\'"
+    @collection.size.should eq 1
+    # note: not Usergrid::Entity objects: it is an Array for this kind of query
+    values = @collection.entities.first
+    values[0].should eq @entity_data[0][:name]
+    values[1].should eq @entity_data[0][:value]
+  end
+
+  it "should be able to select redefined data elements" do
+    @collection.query "select { test1: name, test2 : value } where name = \'#{@entity_data[0][:name]}\'"
+    @collection.size.should eq 1
+    # note: not Usergrid::Entity objects: it is a Hash for this kind of query
+    values = @collection.entities.first
+    values.test1.should eq @entity_data[0][:name]
+    values.test2.should eq @entity_data[0][:value]
+  end
+
   it "should be able to find an entity" do
     @collection.query
     entity = @collection.detect { |e| e.name == @entity_data[5][:name] }

data/usergrid_iron.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Usergrid::VERSION
 
   gem.add_dependency 'rest-client'
-  gem.add_dependency 'json_pure'
+  gem.add_dependency 'multi_json'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usergrid_iron
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4175816790877245614
+      hash: -270819572663973399
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4175816790877245614
+      hash: -270819572663973399
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24