usergrid_iron 0.0.1 → 0.0.2

data/README.md

@@ -26,65 +26,104 @@ Or install it yourself as:
 Docs: http://apigee.com/docs/usergrid/
 Open source: https://github.com/apigee/usergrid-stack
 
-2. Getting started with the Usergrid_iron SDK is simple! Let's run through some of the
-basic concepts:
+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.
+
+<pre>
+require 'usergrid_iron'
+
+# fill in your values here!
+usergrid_api = 'http://localhost:8080'
+organization = ''
+application = ''
+username = ''
+password = ''
+
+application = Usergrid::Application.new "#{usergrid_api}/#{organization}/#{application}"
+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' }
+
+# let's get the dog from the response and grab its persistent id
+dog = response.entity
+uuid = dog.uuid
+
+# let's retrieve a dog from the server by UUID
+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!)
 
 <pre>
   require 'usergrid_iron'
 
-  # set the Usergrid (or Apigee App Services) URL
-  usergrid_api = Usergrid::Resource.new 'http://localhost:8080'
+  usergrid_api = 'http://localhost:8080'
+  org_name = 'test-organization'
+  username = 'test'
+  password = 'test'
+  app_name = 'dog_sitter'
+
+  ## first, let's get that setup out of the way ##
 
   # get a management context & login the superuser
-  management = usergrid_api.management
-  management.login 'test', 'test'
+  management = Usergrid::Management.new usergrid_api
+  management.login username, password
 
   # get the organization context & create a new application
-  app_name = 'dogs_application'
-  organization = management.organization 'test-organization'
-  application = organization.create_application app_name
+  organization = management.organization org_name
+  new_application = organization.create_application app_name
+
+  # create an user for our application
+  new_application.create_user 'username', 'name', 'email@test.com', 'password'
+
 
-  # create an application user
-  application.create_user 'app_username', 'app_name', 'app_email@test.com', 'password'
+  ## now we can play with the puppies! ##
 
-  # get a new application context and login as the new user
-  application = usergrid_api.application 'test-organization', app_name
-  application.login 'app_username', 'password'
+  # login to our new application as our new user
+  application = Usergrid::Application.new "#{usergrid_api}/#{org_name}/#{app_name}"
+  application.login 'username', 'password'
 
-  # create a dog
-  application.create_entity   'dogs', { breed: 'Black Mouth Cur', name: 'Old Yeller' }
+  # we can start with our dog again
+  application.create_entity 'dogs', { breed: 'Black Mouth Cur', name: 'Old Yeller' }
 
-  # create several more dogs
+  # but this time let's create several more dogs at once
   application.create_entities 'dogs', [{ breed: 'Catalan sheepdog', name: 'Einstein' },
-                                       { breed: 'Cocker Spaniel', name: 'Lady' },
-                                       { breed: 'Mixed', name: 'Benji' }]
+      { breed: 'Cocker Spaniel', name: 'Lady' },
+      { breed: 'Mixed', name: 'Benji' }]
 
-  # retrieves the dogs collection from Usergrid and prints their names
-  dogs = application['dogs'].get.collection
+  # retrieve all the dogs (well, the first 'page' anyway) and tell them hi!
+  dogs = application['dogs'].collection
   dogs.each do |dog|                          # works just like an array
-    pp dog.name                               # entities automatically have attributes
+    puts "Hello, #{dog.name}!"                # entities automatically have attributes
   end
 
-  # query for a dog named Benji
-  dogs.query "select * where name = 'Benji'"  # repopulates the collection
-  benji = dogs.first
+  # "Benji, come!"
+  benji = dogs.query("select * where name = 'Benji'").entity  # shortcut: entity will return the first in the collection
 
   # modify Benji's attributes & save
-  benji.command = 'come home'                     # use attribute access
+  benji.location = 'home'                     # use attribute access
   benji['breed'] = 'American Cocker Spaniel'  # or access it like a Hash
   benji.save
 
-  # get the dog by uuid - the attributes were saved!
-  dog = application["dogs/#{benji.uuid}"].get.entity
-  if dog.command == 'come home'
-    puts "Benji's coming home!"
-  else
-    raise 'Benji is a lost puppy!'
+  # 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'
+    puts "Benji's home!"
   end
 
 </pre>
 
-Looking for a specific feature? Check out the rspecs, there are examples of almost everything!
+Whew. That's enough for now. But looking for a specific feature? Check out the rspecs,
+there are examples of nearly everything!
 
 
 ## Contributing

data/lib/usergrid/core/application.rb

@@ -1,7 +1,9 @@
 module Usergrid
   class Application < Resource
 
-    def initialize(url, api_url, options)
+    def initialize(url, options={})
+      org_name = url.split('/')[-2]
+      api_url = url[0..url.index(org_name)-2]
       super url, api_url, options
     end
 

data/lib/usergrid/core/collection.rb

@@ -35,11 +35,11 @@ module Usergrid
     end
 
     def create_entity(data)
-      response = self.post data
-      response.entity
+      self.post data
     end
+    alias_method :create_entities, :create_entity
 
-    # options: 'reversed', 'start', 'cursor', 'limit', 'permission'
+    ## options: 'reversed', 'start', 'cursor', 'limit', 'permission'
     #def update(new_data, query=nil, options={}) # todo: enable when server is fixed
     #  options = options.symbolize_keys
     #  @query_params = query ? options.merge({ql: query}) : options

data/lib/usergrid/core/entity.rb

@@ -37,7 +37,7 @@ module Usergrid
     end
 
     def to_s
-      "resource: #{url}\ndata: #{data.pretty_inspect}"
+      "resource: #{url}\ndata: #{data}"
     end
 
     private

data/lib/usergrid/core/management.rb

@@ -1,12 +1,17 @@
 module Usergrid
   class Management < Resource
 
-    def initialize(api_url, options)
-      url = concat_urls(api_url, 'management')
+    def initialize(url, options={})
+      management = url.split('/')[-1]
+      if management == 'management'
+        api_url = url[0..url.index(management)-2]
+      else
+        api_url = url
+        url = concat_urls(api_url, 'management')
+      end
       super url, api_url, options
     end
 
-    # one way: cannot delete organizations
     def create_organization(organization, username, name, email, password)
       data = { organization: organization,
                username: username,
@@ -22,7 +27,7 @@ module Usergrid
 
     def organization(organization)
       url = self["organizations/#{organization}"].url
-      Organization.new url, api_url, options
+      Organization.new url, options
     end
 
     def users

data/lib/usergrid/core/organization.rb

@@ -2,7 +2,9 @@ require 'uri'
 module Usergrid
   class Organization < Resource
 
-    def initialize(url, api_url, options)
+    def initialize(url, options={})
+      org_name = url.split('/')[-1]
+      api_url = url[0..url.index('management')-2]
       super url, api_url, options
     end
 
@@ -24,7 +26,7 @@ module Usergrid
     end
 
     def application(name_or_uuid)
-      Usergrid::Application.new concat_urls(api_url, "#{name}/#{name_or_uuid}"), api_url, options
+      Usergrid::Application.new concat_urls(api_url, "#{name}/#{name_or_uuid}"), options
     end
 
     def users(query=nil)

data/lib/usergrid/core/resource.rb

@@ -43,7 +43,7 @@ module Usergrid
 
     # application defaults to sandbox if none provided
     def application(organization, application='sandbox')
-      Usergrid::Application.new concat_urls(api_url, "#{organization}/#{application}"), api_url, options
+      Usergrid::Application.new concat_urls(api_url, "#{organization}/#{application}"), options
     end
 
     def query(query=nil, options={})

data/lib/usergrid/version.rb

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

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'simplecov'
 require 'rspec'
 require 'yaml'
 require 'securerandom'
-require_relative '../lib/usergrid'
+require_relative '../lib/usergrid_iron'
 
 LOG = Logger.new(STDOUT)
 RestClient.log=LOG

data/spec/usergrid/core/application_spec.rb

@@ -258,7 +258,7 @@ describe Usergrid::Application do
     roles.size.should == size
   end
 
-  it "should be able to create a new collection and access it" do # todo
+  it "should be able to create a new collection and access it" do
     entities = (1..4).collect do |i|
       { name: "test_#{i}" }
     end

data/spec/usergrid/core/collection_spec.rb

@@ -2,16 +2,15 @@ describe Usergrid::Collection do
 
   before :all do
     @application = create_random_application
+    @user = create_random_user @application, true
 
     @collection = @application['tests'].collection
     @entity_data = []
     (1..10).each do |i|
       test = { name: "test_#{i}" }
       @entity_data << test
-      @collection.create_entity test
     end
-
-    @user = create_random_user @application, true
+    @collection.create_entities @entity_data
   end
 
   after :all do

data/spec/usergrid/extensions/hash_spec.rb

@@ -4,7 +4,7 @@ describe Hash do
 
   it "should add dot notation recursively" do
     h = { test1: 'test1', test2: { test2a: 'test2a' }, test3: [ { test3a: 'test3a' }] }
-    expect { h.test1 }.should raise_error
+    expect { h.test1 }.to raise_error
     h.add_dot_notation!
     h.test1.should eq 'test1'
     h.test2.test2a.should eq 'test2a'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usergrid_iron
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -115,7 +115,6 @@ files:
 - bin/ldiff
 - bin/restclient
 - bin/rspec
-- lib/usergrid.rb
 - lib/usergrid/core/application.rb
 - lib/usergrid/core/collection.rb
 - lib/usergrid/core/entity.rb
@@ -125,6 +124,7 @@ files:
 - lib/usergrid/extensions/hash.rb
 - lib/usergrid/extensions/response.rb
 - lib/usergrid/version.rb
+- lib/usergrid_iron.rb
 - spec/spec_helper.rb
 - spec/spec_settings.yaml
 - spec/usergrid/core/application_spec.rb
@@ -149,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1597899148183039050
+      hash: -4175816790877245614
 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: -1597899148183039050
+      hash: -4175816790877245614
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24