usergrid_iron 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usergrid_iron.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+* 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.

data/README.md

@@ -0,0 +1,133 @@
+# Usergrid_iron
+
+Usergrid_iron enables simple, low-level Ruby access to Apigee's App Services (aka Usergrid) REST API with minimal
+dependencies.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'usergrid_iron'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install usergrid_iron
+
+
+## Usage
+
+1. 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
+
+2. Getting started with the Usergrid_iron SDK is simple! Let's run through some of the
+basic concepts:
+
+<pre>
+  require 'usergrid_iron'
+
+  # set the Usergrid (or Apigee App Services) URL
+  usergrid_api = Usergrid::Resource.new 'http://localhost:8080'
+
+  # get a management context & login the superuser
+  management = usergrid_api.management
+  management.login 'test', 'test'
+
+  # get the organization context & create a new application
+  app_name = 'dogs_application'
+  organization = management.organization 'test-organization'
+  application = organization.create_application app_name
+
+  # create an application user
+  application.create_user 'app_username', 'app_name', 'app_email@test.com', 'password'
+
+  # get a new application context and login as the new user
+  application = usergrid_api.application 'test-organization', app_name
+  application.login 'app_username', 'password'
+
+  # create a dog
+  application.create_entity   'dogs', { breed: 'Black Mouth Cur', name: 'Old Yeller' }
+
+  # create several more dogs
+  application.create_entities 'dogs', [{ breed: 'Catalan sheepdog', name: 'Einstein' },
+                                       { breed: 'Cocker Spaniel', name: 'Lady' },
+                                       { breed: 'Mixed', name: 'Benji' }]
+
+  # retrieves the dogs collection from Usergrid and prints their names
+  dogs = application['dogs'].get.collection
+  dogs.each do |dog|                          # works just like an array
+    pp 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
+
+  # modify Benji's attributes & save
+  benji.command = 'come 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!'
+  end
+
+</pre>
+
+Looking for a specific feature? Check out the rspecs, there are examples of almost everything!
+
+
+## Contributing
+
+We welcome your enhancements!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write some broken rspecs.
+4. Fix the rspecs with your new code.
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push your changes to the upstream branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+We've got 100% rspec coverage and we're looking to keep it that way!
+In order to run the tests, check out the Usergrid open source project
+(https://github.com/apigee/usergrid-stack), build, and launch it locally.
+
+(Note: If you change your local Usergrid setting from the default, be sure to update
+usergrid_iron/spec/spec_settings.yaml to match.)
+
+
+## Notes
+
+The following features are not currently implemented on the server:
+
+* delete organization
+* delete application
+* delete user
+
+
+## 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
+ *
+ *   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/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new("spec:coverage")

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/restclient

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'restclient' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rest-client', 'restclient')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/usergrid.rb

@@ -0,0 +1,27 @@
+require 'logger'
+require 'json'
+
+module Usergrid
+
+  LOG = Logger.new(STDOUT)
+
+  USERGRID_PATH = File.join File.dirname(__FILE__), 'usergrid'
+
+  def self.usergrid_path *path
+    File.join USERGRID_PATH, *path
+  end
+
+  require usergrid_path('version')
+
+  require usergrid_path('extensions', 'hash')
+  require usergrid_path('extensions', 'response')
+
+  require usergrid_path('core', 'resource')
+  require usergrid_path('core', 'management')
+  require usergrid_path('core', 'organization')
+  require usergrid_path('core', 'application')
+  require usergrid_path('core', 'entity')
+  require usergrid_path('core', 'collection')
+
+  #autoload :Management, usergrid_path('core', 'management')
+end

data/lib/usergrid/core/application.rb

@@ -0,0 +1,70 @@
+module Usergrid
+  class Application < Resource
+
+    def initialize(url, api_url, options)
+      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
+    end
+
+    # note: collection_name s/b plural!
+    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)
+    end
+
+    def rolenames(query=nil, options={})
+      self[__method__].query(query, options).data.data.keys
+    end
+
+    def counter_names
+      self['counters'].get.data.data
+    end
+
+    # other_params: 'start_time' (ms), 'end_time' (ms), 'resolution' (minutes)
+    def counter(name, other_params={})
+      options = other_params.merge({counter: name})
+      self['counters'].get({params: options})
+    end
+
+  end
+end

data/lib/usergrid/core/collection.rb

@@ -0,0 +1,71 @@
+module Usergrid
+  class Collection < Entity
+    include Enumerable
+
+    attr_reader :query_params
+
+    def initialize(url, api_url, options={}, response=nil)
+      super url, api_url, options, response
+    end
+
+    def collection
+      self
+    end
+
+    def entities
+      get unless response
+      response.entities
+    end
+
+    def [](k)
+      entities[k]
+    end
+
+    def []=(k,v)
+      raise "unsupported operation"
+    end
+
+    # does not save entities! just fields (eg. 'name')
+    def save
+      super save
+    end
+
+    def each(&block)
+      entities.each &block
+    end
+
+    def create_entity(data)
+      response = self.post data
+      response.entity
+    end
+
+    # 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
+    #  self.put({params: @query_params }, new_data)
+    #  self
+    #end
+
+    # options: 'reversed', 'start', 'cursor', 'limit', 'permission'
+    def query(query=nil, options={})
+      options = options.symbolize_keys
+      @query_params = query ? options.merge({ql: query}) : options
+      self.get({params: @query_params })
+      self
+    end
+
+    def size
+      entities.size
+    end
+
+    def cursor
+      response.data.cursor || nil
+    end
+
+    def next_page
+      query(nil, @query_params.merge({cursor: cursor}))
+    end
+
+  end
+end