mashery 0.0.10 → 0.0.11

data/README.textile

@@ -25,3 +25,27 @@ Before you can successfully call an API method, you must set these environment v
 bc. $ export MASHERY_SITE_ID=666
 $ export MASHERY_API_KEY=cafebebedeadbeefcafebebedeadbeef
 $ export MASHERY_SHARED_SECRET=blahblahblah
+
+h3. Querying objects
+
+The Mashery API supports querying the following types of objects: "members":http://support.mashery.com/docs/mashery_api/member/, "applications":http://support.mashery.com/docs/mashery_api/application/, "keys":http://support.mashery.com/docs/mashery_api/key/, "services":http://support.mashery.com/docs/mashery_api/service/, and "roles":http://support.mashery.com/docs/mashery_api/role/.
+
+To perform a query, construct a Query object for the type of object you want to query:
+
+bc. query = Mashery::Query.new('members')
+members = query.fetch_all
+
+The @fetch_all@ method will automatically paginate through the results for you. You can also control this yourself with the @page@ parameter and @execute@:
+
+bc. query = Mashery::Query.new('members', :page => 2)
+result = query.execute
+items = result['items']
+
+(Or, use the @items@ method, which combines @execute@ and @result['items']@ -- however, this does not return result set metadata, like current page and total pages.)
+
+The default will return all fields (e.g., @SELECT * FROM members@). To control this, specify the @:fields@ parameter.
+
+To control which records are returned, specify the @:where@ parameter.
+
+bc. query = Mashery::Query.new('members', :where => 'username = "Jeff"'
+

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/mashery.rb

@@ -4,6 +4,7 @@ require 'mashery/api_object_base'
 require 'mashery/member'
 require 'mashery/key'
 require 'mashery/role'
+require 'mashery/query'
 
 module Mashery
   mattr_accessor :client

data/lib/mashery/query.rb

@@ -0,0 +1,63 @@
+module Mashery
+  class Query
+    OBJECT_TYPES = ['members', 'keys', 'services', 'roles', 'applications']
+    DEFAULT_QUERIES_PER_SECOND = 2
+
+    attr_reader :object_type, :fields
+    attr_accessor :page
+
+    def initialize(object_type, options={})
+      if !OBJECT_TYPES.include?(object_type)
+        raise "Invalid object type. '#{object_type}' must be in #{OBJECT_TYPES.inspect}"
+      end
+
+      @object_type = object_type
+
+      if options[:fields]
+        @fields = options[:fields]
+      else
+        @fields = "*"
+      end
+
+      @where = options[:where]
+      @page = options[:page]
+    end
+
+    def page_clause
+      "PAGE #{@page}" if @page
+    end
+
+    def where_clause
+      "WHERE #{@where}" if @where
+    end
+
+    def query_string
+      "SELECT #{fields} FROM #{object_type} #{where_clause} #{page_clause}"
+    end
+
+    def execute
+      Mashery.client.call_remote('object.query', query_string)
+    end
+
+    def items
+      execute['items']
+    end
+
+    # Page through the results. Due heavy use of the API, this method
+    # takes a qps parameter to control how often the API is called.
+    def fetch_all(qps=DEFAULT_QUERIES_PER_SECOND)
+      response = execute
+      items = response['items']
+
+      while response['current_page'] < response['total_pages']
+        self.page = response['current_page'] + 1
+        response = execute
+        items = items + response['items']
+        
+        sleep(1.0/DEFAULT_QUERIES_PER_SECOND)
+      end
+
+      return items
+    end
+  end
+end

data/mashery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mashery}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Moseley"]
-  s.date = %q{2010-08-13}
+  s.date = %q{2010-08-26}
   s.email = %q{brian@outside.in}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/mashery/exceptions.rb",
      "lib/mashery/key.rb",
      "lib/mashery/member.rb",
+     "lib/mashery/query.rb",
      "lib/mashery/role.rb",
      "mashery.gemspec",
      "tasks/mashery.thor"
@@ -35,14 +36,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/outsidein/mashery-rb}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby library for the Mashery API}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mashery
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Brian Moseley
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-13 00:00:00 -04:00
+date: 2010-08-26 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -40,6 +41,7 @@ files:
 - lib/mashery/exceptions.rb
 - lib/mashery/key.rb
 - lib/mashery/member.rb
+- lib/mashery/query.rb
 - lib/mashery/role.rb
 - mashery.gemspec
 - tasks/mashery.thor
@@ -53,23 +55,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby library for the Mashery API