usergrid_iron 0.0.4 → 0.0.5

data/README.md

@@ -47,7 +47,7 @@ application = Usergrid::Application.new "#{usergrid_api}/#{organization}/#{appli
 application.login username, password
 
 # create and store a dog in the 'dogs' collection on the server
-response = application.create_entity 'dogs', { breed: 'Black Mouth Cur', name: 'Old Yeller' }
+response = application.create_dog breed: 'Black Mouth Cur', name: 'Old Yeller'
 
 # let's get the dog from the response and grab its persistent id
 dog = response.entity
@@ -89,7 +89,7 @@ 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', 'password'
+  new_application.create_user username: 'username', password: 'password'
 
 
   ## now we can play with the puppies! ##
@@ -99,10 +99,11 @@ you shouldn't need to do anything!)
   application.login 'username', 'password'
 
   # we can start with our dog again
-  application.create_entity 'dogs', { breed: 'Black Mouth Cur', name: 'Old Yeller' }
+  application.create_dog breed: 'Black Mouth Cur', name: 'Old Yeller'
 
   # but this time let's create several more dogs at once
-  application.create_entities 'dogs', [{ breed: 'Catalan sheepdog', name: 'Einstein' },
+  application.create_dogs [
+      { breed: 'Catalan sheepdog', name: 'Einstein' },
       { breed: 'Cocker Spaniel', name: 'Lady' },
       { breed: 'Mixed', name: 'Benji' }]
 
@@ -122,7 +123,7 @@ you shouldn't need to do anything!)
 
   # query for the dogs that are home (should just be Benji)
   dogs = application['dogs'].query("select * where location = 'home'").collection
-  if dogs.size == 1 && dogs.first == 'home'
+  if dogs.size == 1 && dogs.first.location == 'home'
     puts "Benji's home!"
   end
 
@@ -154,7 +155,24 @@ usergrid_iron/spec/spec_settings.yaml to match.)
 
 ## Release notes
 
-### 0.0.3 
+### 0.0.5
+* New features
+  1. added create_* method for application
+* Backend changes
+  1. eliminated serialization of reserved attributes
+* Incompatible changes
+  1. deprecated `Application::create_user username, password, ...`, use `create_user username: 'user', password: 'password'`
+
+### 0.0.4
+* New features
+  1. empty? check for collection
+  2. update queries (batch update)
+* Backend changes
+  1. Additional data sanity checks
+  2. Additional flexibility in concat_urls
+  3. Cleanup
+
+### 0.0.3
 * New features
   1. Support for lists returned when making parameterized queries:
 	 <pre>select username, email where…</pre>

data/lib/usergrid/core/application.rb

@@ -7,51 +7,24 @@ module Usergrid
       super url, api_url, options
     end
 
-    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!
+    # note: collection_name s/b plural, but the server will change it if not
     def create_entity(collection_name, entity_data)
       self[collection_name].post entity_data
     end
     alias_method :create_entities, :create_entity
 
-    def users(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def groups(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def activities(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def devices(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def assets(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def folders(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def events(query=nil, options={})
-      self[__method__].query(query, options)
-    end
-
-    def roles(query=nil, options={})
-      self[__method__].query(query, options)
+    # allow create_something(hash_or_array) method
+    def method_missing(method, *args, &block)
+      method_s = method.to_s
+      if method_s.start_with? 'create_'
+        entity = method_s.split('_')[1]
+        return _create_user *args if entity == 'user' && args[0].is_a?(String) # backwards compatibility
+        create_entity entity, *args
+      elsif method_s.end_with? 's' # shortcut for retrieving collections
+        self[method].query(*args)
+      else
+        super method, args, block
+      end
     end
 
     def counter_names
@@ -64,5 +37,17 @@ module Usergrid
       self['counters'].get({params: options})
     end
 
+    private
+
+    def _create_user(username, password, email=nil, name=nil, invite=false)
+      LOG.warn "create_user(username, password, ...) is deprecated"
+      user_hash = { username: username,
+                    password: password,
+                    email: email,
+                    name: name,
+                    invite: invite }
+      create_entity 'users', user_hash
+    end
+
   end
 end

data/lib/usergrid/core/entity.rb

@@ -40,6 +40,12 @@ module Usergrid
       "resource: #{url}\ndata: #{data}"
     end
 
+    def to_json(*args)
+      data.except(RESERVED).to_json *args
+    end
+    alias :encode :to_json
+    alias :dump :to_json
+
     private
 
     def method_missing(method, *args, &block)

data/lib/usergrid/core/resource.rb

@@ -3,8 +3,9 @@ require 'rest_client'
 module Usergrid
   class Resource < RestClient::Resource
 
+    RESERVED = %w( created modified metadata uri )
     DEFAULT_API_URL = 'https://api.usergrid.com'
-    TYPE_HEADERS = { :content_type => :json, :accept => :json }
+    TYPE_HEADERS = { content_type: :json, accept: :json }
 
     attr_reader :current_user, :api_url
 
@@ -59,10 +60,17 @@ module Usergrid
     end
 
     def entity
+      get unless response
       response.entity
     end
 
+    def entities
+      get unless response
+      response.entities
+    end
+
     def collection
+      get unless response
       Collection.new url, api_url, options, response
     end
 
@@ -85,12 +93,12 @@ module Usergrid
     end
 
     def post(payload, additional_headers={}, &block)
-      payload = MultiJson.dump(payload) if payload.is_a?(Hash) || payload.is_a?(Array)
+      payload = MultiJson.dump(payload) unless payload.is_a? String
       self.response = super payload, additional_headers, &block
     end
 
     def put(payload, additional_headers={}, &block)
-      payload = MultiJson.dump(payload) if payload.is_a?(Hash) || payload.is_a?(Array)
+      payload = MultiJson.dump(payload) unless payload.is_a? String
       self.response = super payload, additional_headers, &block
     end
 

data/lib/usergrid/extensions/hash.rb

@@ -1,10 +1,5 @@
 class Hash
 
-  # recursive
-  def add_dot_notation!
-    add_dot_notation_recurse! self
-  end
-
   # not recursive
   def symbolize_keys
     inject({}) do |options, (key, value)|
@@ -13,15 +8,23 @@ class Hash
     end
   end
 
-  private
+  def except(*keys)
+    dup.except! *keys
+  end
 
-  def add_dot_notation_recurse!(_hash)
+  def except!(*keys)
+    keys.each { |key| key.is_a?(Array) ? except!(*key) : delete(key) }
+    self
+  end
+
+  # recursive
+  def add_dot_notation!(_hash=self)
     _hash.each do |k,v|
       getter = k.to_sym; setter = "#{k}=".to_sym
       _hash.define_singleton_method getter, lambda { _hash[k] } unless _hash.respond_to? getter
       _hash.define_singleton_method setter, lambda { |v| _hash[k] = v } unless _hash.respond_to? setter
-      add_dot_notation_recurse!(v) if v.is_a? Hash
-      v.each { |e| add_dot_notation_recurse!(e) if e.is_a? Hash } if v.is_a? Array
+      add_dot_notation!(v) if v.is_a? Hash
+      v.each { |e| add_dot_notation!(e) if e.is_a? Hash } if v.is_a? Array
     end
   end
 end

data/lib/usergrid/version.rb

@@ -1,3 +1,3 @@
 module Usergrid
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/usergrid/core/application_spec.rb

@@ -10,10 +10,16 @@ describe Usergrid::Application do
     delete_application @application
   end
 
+  it "should be able to create a user using deprecated syntax" do
+    random = SecureRandom.hex
+    response = @application.create_user "username_#{random}", 'password'
+    response.entity.uuid.should_not be_nil
+  end
+
   it "should be able to create, login, and delete a user" do
     random = SecureRandom.hex
     application = Usergrid::Application.new @application.url # create application resource that's not logged in
-    response = application.create_user "username_#{random}", 'password'
+    response = application.create_user username: "username_#{random}", password: 'password'
     entity = response.entity
     application.login "username_#{random}", 'password'
     begin
@@ -201,7 +207,8 @@ describe Usergrid::Application do
     response = @application.counter 'test'
     counter = response.data.counters.first
     counter.name.should eq 'test'
-    counter.values.last.first.value.should be > 0
+    # can't reliably test this - counters are batched on server
+    #counter.values.last.first.value.should be > 0
   end
 
   it "should be able to create, retrieve, and delete roles" do
@@ -251,13 +258,40 @@ describe Usergrid::Application do
   end
 
   it "should be able to create a new collection and access it" do
-    entities = (1..4).collect do |i|
-      { name: "test_#{i}" }
-    end
+    entities = (1..4).collect { |i| { name: "test_#{i}" } }
     @application.create_entities 'tests', entities
     response = @application['tests'].get
     collection = response.collection
     collection.size.should eq 4
   end
 
+  it "should be able to create a new collection via create_ method and access it" do
+    entities = (1..4).collect { |i| { name: "test_#{i}" } }
+    @application.create_moretests entities
+    response = @application['tests'].get
+    collection = response.collection
+    collection.size.should eq 4
+  end
+
+  it "should be able to access a collection without calling get" do
+    entities = (1..4).collect { |i| { name: "test_#{i}" } }
+    @application.create_entities 'tests', entities
+    collection = @application['tests'].collection
+    collection.size.should eq 4
+  end
+
+  it "should be able to access entities without calling get" do
+    entities = (1..4).collect { |i| { name: "test_#{i}" } }
+    @application.create_entities 'tests', entities
+    entities = @application['tests'].entities
+    entities.size.should eq 4
+  end
+
+  it "should be able to query using dot notation" do
+    entities = (1..4).collect { |i| { name: "test_#{i}" } }
+    @application.create_btests entities
+    entities = @application.btests("name = 'test_1'").entities
+    entities.size.should eq 1
+  end
+
 end

data/spec/usergrid/core/entity_spec.rb

@@ -46,4 +46,10 @@ describe Usergrid::Entity do
     @application['foobars'].get.entity.should be_nil
   end
 
+  it "should not serialize reserved attributes" do
+    dump = MultiJson.dump @user
+    hash = MultiJson.load dump
+    Usergrid::Resource::RESERVED.each { |a| hash.should_not have_key(a) }
+  end
+
 end

data/usergrid_iron.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
                         (aka Usergrid) REST API with minimal dependencies.}
   gem.homepage      = "https://github.com/scottganyo/usergrid_iron"
 
-  gem.files         = `/usr/local/git/bin/git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(spec|spec|features)/})
   gem.name          = "usergrid_iron"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usergrid_iron
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-13 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1515715500160031430
+      hash: -2026056560338254280
 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: 1515715500160031430
+      hash: -2026056560338254280
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24