xoopit-cloud_query 0.1.5 → 0.2.0

data/README.markdown

@@ -1,7 +1,7 @@
-cloudquery
+CloudQuery
 ==========
 
-Client for Xoopit's cloudquery API
+Client for Xoopit's CloudQuery API
 
 Install
 -------
@@ -11,21 +11,21 @@ care of it. If not, `sudo gem install json rack taf2-curb` will do it.
 
 Be sure you've run `gem sources -a http://gems.github.com` once on your system. Then:
 
-    sudo gem install xoopit-cloudquery
+    sudo gem install xoopit-cloudquery-ruby
 
 Simple contacts application example
 -----------------------------------
 
     > require 'rubygems'
     => true
-    > require 'cloudquery'
+    > require 'cloud_query'
     => true
-    > include Cloudquery
+    > include CloudQuery
     => Object
     > secret = Client.get_secret(<account_name>, <password>)
     => "your secret appears here"
     > c = Client.new(:account => '<account_name>', :secret => secret)
-    => #<Cloudquery::Client:0x10b1b24 @secure=true, @secret="your secret appears here", @account="<account_name>", @document_id_method=nil>
+    => #<CloudQuery::Client:0x10b1b24 @secure=true, @secret="your secret appears here", @account="<account_name>", @document_id_method=nil>
     > c.add_indexes('superheroes')
     => {"result"=>["kMzzzybpqpY"], "size"=>1, "STATUS"=>200}
     > c.add_schema(File.open('simple.contact.xml'))
@@ -35,10 +35,10 @@ Simple contacts application example
         'simple.contact.email' => ['steve.rogers@example.com','captain.america@marvel.com'],
         'simple.contact.telephone' => ['555-555-5555','123-456-6789'],
         'simple.contact.address' => ['Lower East Side, NY NY'],
-        'simple.contact.birthday' => Date.parse('July 4, 1917'),
+        'simple.contact.birthday' => Time.parse('July 4, 1917').to_i_milliseconds,
         'simple.contact.note' => 'Captain America!',
       }
-    => {"simple.contact.birthday"=>#<Date: 4842827/2,0,2299161>, "simple.contact.address"=>["Lower East Side, NY NY"], "simple.contact.telephone"=>["555-555-5555", "123-456-6789"], "simple.contact.note"=>"Captain America!", "simple.contact.email"=>["steve.rogers@example.com", "captain.america@marvel.com"], "simple.contact.name"=>"Steve Rogers"}
+    => {"simple.contact.birthday"=>-1656604800000, "simple.contact.address"=>["Lower East Side, NY NY"], "simple.contact.telephone"=>["555-555-5555", "123-456-6789"], "simple.contact.note"=>"Captain America!", "simple.contact.email"=>["steve.rogers@example.com", "captain.america@marvel.com"], "simple.contact.name"=>"Steve Rogers"}
     > c.add_documents('superheroes', doc, 'simple.contact')
     => {"result"=>["nDLCNLPo3oHtxANzG4YBn5kMzzzybpqpY"], "size"=>1, "STATUS"=>201}
     > docs = [
@@ -47,7 +47,7 @@ Simple contacts application example
         'simple.contact.email' => ['clark.kent@example.com','superman@dc.com'], 
         'simple.contact.telephone' => ['555-123-1234','555-456-6789'],
         'simple.contact.address' => ['344 Clinton St., Apt. #3B, Metropolis', 'The Fortess of Solitude, North Pole'],
-        'simple.contact.birthday' => Date.parse('June 18, 1938'),
+        'simple.contact.birthday' => Time.parse('June 18, 1938').to_i_milliseconds,
         'simple.contact.note' => 'Superhuman strength, speed, stamina, durability, senses, intelligence, regeneration, and longevity; super breath, heat vision, x-ray vision and flight. Member of the justice league.'
       },
       {
@@ -55,7 +55,7 @@ Simple contacts application example
         'simple.contact.email' => ['bruce.wayne@example.com','batman@dc.com'],
         'simple.contact.telephone' => ['555-123-6666','555-456-6666'],
         'simple.contact.address' => ['1007 Mountain Drive, Gotham', 'The Batcave, Gotham'],
-        'simple.contact.birthday' => Date.parse('February 19, 1939'),
+        'simple.contact.birthday' => Time.parse('February 19, 1939').to_i_milliseconds,
         'simple.contact.note' => 'Sidekick is Robin. Has problems with the Joker. Member of   e justice league.'
       }
     ]

data/lib/cloud_query/client.rb

@@ -0,0 +1,370 @@
+module CloudQuery
+  class Client
+    attr_reader :account
+    attr_writer :secret
+
+    # Create a new instance of the client
+    #
+    # It's highly recommended to set options <tt>:account</tt>
+    # and <tt>:secret</tt>. Creating a client without an account
+    # and secret isn't very useful. 
+    #
+    # ==== Acceptable options:
+    #   :account => <account name> (default => nil)
+    #   :secret => <API secret> (default => nil)
+    #   :document_id_method => <method name> (default => nil)
+    #   :secure => Boolean (use HTTPS, default => true)
+    #
+    # If +document_id_method+ is set, it will be called on each
+    # document as a part of +add_documents+ and +update_documents+
+    # which should inject an <tt>'#.#'</tt> key-value pair as a
+    # simple way to tie app PKs to doc ids.
+    def initialize(options={})
+      # unless options[:account] && options[:secret]
+      #   raise "Client requires :account => <account name> and :secret => <secret>"
+      # end
+      
+      @account = options[:account]
+      @secret = options[:secret]
+      
+      @secure = options[:secure] != false # must pass false for insecure
+      
+      @document_id_method = options[:document_id_method]
+    end
+
+
+    ## Account management
+    
+    # Retrieve the API secret for an +account+, using the +password+ (uses HTTPS)
+    def self.get_secret(account, password)
+      auth = Request.new(:path => "#{PATH}/auth")
+      curl = Curl::Easy.new(auth.url) do |c|
+        c.enable_cookies = true
+        c.cookiejar = COOKIE_JAR
+      end
+      params = Rack::Utils.build_query({"name" => account, "password" => password})
+      curl.http_post(params)
+      
+      if (curl.response_code/100) == 2
+        curl.url = Request.new(:path => "#{PATH}/#{API_PATHS[:account]}/#{account}").url
+        curl.http_get
+        response = JSON.parse(curl.body_str)
+        response['result']['secret']
+      else
+        STDERR.puts "Error: #{curl.response_code} #{Rack::Utils::HTTP_STATUS_CODES[curl.response_code]}"
+      end
+    end
+
+    # change password
+    # optionally change the secret
+    def self.change_password(account, old_password, new_password, new_secret=nil)
+      secret = get_secret(account, old_password)
+      c = Client.new(:account => account, :secret => secret, :secure => true)
+      a = c.get_account()['result']
+      a['password'] = new_password
+      a.delete('secret')
+      if new_secret != nil
+        a['secret'] = new_secret
+      end
+      c.update_account(a)
+      return (new_secret != nil ? new_secret : secret); 
+    end
+
+    # Get the account document
+    def get_account
+      send_request get(account_path)
+    end
+    
+    # Update the account document.
+    #
+    # Use this method to change the API secret:
+    #   update_account({'secret' => 'your-new-secret'})
+    def update_account(account_doc={})
+      body = JSON.generate(account_doc)
+      send_request put(account_path, body)
+    end
+    
+    # Delete the account.
+    #
+    # ==== BEWARE: THIS WILL ACTUALLY DELETE YOUR ACCOUNT.
+    def delete_account!
+      send_request delete(account_path)
+    end
+
+
+    ## Schema management
+    
+    # Add a schema to the account. +xml+ can be a +String+
+    # or +File+-like (responds to <tt>:read</tt>)
+    def add_schema(xml)
+      body = xml.respond_to?(:read) ? xml.read : xml
+      request = post(build_path(API_PATHS[:schema]), body)
+      send_request(request, CONTENT_TYPES[:xml])
+    end
+    
+    # Delete a schema from the account, by name
+    # if cascade is true, all documents with the specified schema will be deleted
+    # (use with care)
+    def delete_schema(schema_name, cascade=nil)
+      c = cascade ? {:cascade => 'true'} : nil
+      send_request delete(build_path(
+        API_PATHS[:schema],
+        Rack::Utils.escape("$.name:\"#{schema_name}\"")
+      ), c)
+    end
+    
+    # Get the schemas for the account.
+    #
+    # NOTE: returned format is not the same as accepted for input
+    def get_schemas
+      send_request get(build_path(API_PATHS[:schema]))
+    end
+    
+
+    ## Index management
+    
+    # Add one or more indexes to the account, by name or id
+    def add_indexes(*indexes)
+      body = JSON.generate(indexes.flatten)
+      send_request post(build_path(API_PATHS[:indexes]), body)
+    end
+    
+    # Delete one or more indexes from the account, by name or id
+    # <tt>indexes = '*'</tt> will delete all indexes
+    def delete_indexes(*indexes)
+      indexes = url_pipe_join(indexes)
+      send_request delete(build_path(API_PATHS[:indexes], indexes))
+    end
+    
+    # Get the indexes from the account. Returns a list of ids
+    def get_indexes
+      send_request get(build_path(API_PATHS[:indexes]))
+    end
+    
+
+    ## Document management
+    
+    # Add documents to the specified +index+
+    #
+    # <tt>index = name</tt> or +id+, <tt>docs = {}</tt> or +Array+ of <tt>{}</tt>.
+    #
+    # Documents with key <tt>'#.#'</tt> and an existing value will be updated.
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def add_documents(index, docs, schemas=[], fieldmode=nil)
+      fm = fieldmode != nil ? {:fieldmode => fieldmode} : nil
+      request = post(
+        build_path(API_PATHS[:documents], index, url_pipe_join(schemas), fm),
+        JSON.generate(identify_documents(docs))
+      )
+      send_request request
+    end
+    
+    # Update documents in the specified +index+
+    
+    # <tt>index = name</tt> or +id+, <tt>docs = {}</tt> or +Array+ of <tt>{}</tt>.
+    #
+    # Documents lacking the key <tt>'#.#'</tt> will be created.
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def update_documents(index, docs, schemas=[], fieldmode=nil)
+      fm = fieldmode != nil ? {:fieldmode => fieldmode} : nil
+      request = put(
+        build_path(API_PATHS[:documents], index, url_pipe_join(schemas), fm),
+        JSON.generate(identify_documents(docs))
+      )
+      send_request request
+    end
+    
+    # Modify documents in the +index+ matching +query+
+    #
+    # <tt>modifications = {...data...}</tt> to update all matching
+    # documents.
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def modify_documents(index, query, modifications, schemas=[], fieldmode=nil)
+      fm = fieldmode != nil ? "?fieldmode=#{fieldmode}" : ""
+      request = put(
+        build_path(API_PATHS[:documents], index, url_pipe_join(schemas), Rack::Utils.escape(query), fm),
+        JSON.generate(modifications)
+      )
+      send_request request
+    end
+    
+    # Delete documents in the +index+ matching +query+
+    #
+    #   query => defaults to '*'
+    #   index => may be an id, index name, or Array of ids or names.
+    #
+    # Operates on all indexes if +index+ = +nil+ or <tt>'*'</tt>
+    #
+    # ==== BEWARE: If +query+ = +nil+ this will delete ALL documents in +index+.
+    #
+    # ==== Acceptable options:
+    #   :sort => a string ("[+|-]schema.field"), or a list thereof (default  => index-order)
+    #   :offset => integer offset into the result set (default => 0)
+    #   :limit => integer limit on number of documents returned per index (default => <no limit>)
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def delete_documents(index, query, options={}, schemas=[])
+      if options[:sort]
+        options[:sort] = Array(options[:sort]).flatten.join(',')
+      end
+      request = delete(
+        build_path(API_PATHS[:documents],
+          url_pipe_join(index),
+          url_pipe_join(schemas),
+          Rack::Utils.escape(query)
+        ),
+        options
+      )
+      send_request request
+    end
+    
+    # Get documents matching +query+
+    # 
+    #   query => defaults to '*'
+    #   index => may be an id, index name, or Array of ids or names.
+    #
+    # Operates on all indexes if +index+ = +nil+ or <tt>'*'</tt>
+    #
+    # ==== Acceptable options:
+    #   :fields => a field name, a prefix match (e.g. 'trans*'), or Array of fields (default => '*')
+    #   :sort => a string ("[+|-]schema.field"), or a list thereof (default  => index-order)
+    #   :offset => integer offset into the result set (default => 0)
+    #   :limit => integer limit on number of documents returned per index (default => <no limit>)
+    #   :fieldmode => 'short' or 'long'/nil, if 'short' then field names will be returned in their
+    #                 short form (no schema name prefix), this can cause naming collisions depending
+    #                 on use schema definition and data etc.
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def get_documents(index, query, options={}, schemas=[])
+      if fields = options.delete(:fields)
+        fields = url_pipe_join(fields)
+      end
+      
+      if options[:sort]
+        options[:sort] = Array(options[:sort]).flatten.join(',')
+      end
+      
+      request = get(
+        build_path(API_PATHS[:documents], 
+          url_pipe_join(index), 
+          url_pipe_join(schemas),
+          url_pipe_join(query),
+          fields
+        ),
+        options
+      )
+      send_request request
+    end
+    
+    # Count documents matching +query+
+    # 
+    #   query => defaults to '*'
+    #   index => may be an id, index name, or Array of ids or names.
+    #
+    # Operates on all indexes if +index+ = +nil+ or <tt>'*'</tt>
+    #
+    # If +schemas+ is not +nil+, ensures existence of the
+    # specified schemas on each document.
+    def count_documents(index, query, schemas)
+      get_documents(index, query, {:fields => '@count'}, schemas)
+    end
+    
+    private
+    def build_path(*path_elements)
+      path_elements.flatten.compact.unshift(PATH).join('/')
+    end
+    
+    def account_path
+      build_path(API_PATHS[:account], @account)
+    end
+    
+    def build_request(options={})
+      Request.new default_request_params.merge(options)
+    end
+    
+    def get(path, params={})
+      build_request(:method => 'GET', :path => path, :params => params)
+    end
+    
+    def delete(path, params={})
+      build_request(:method => 'DELETE', :path => path, :params => params)
+    end
+    
+    def post(path, doc, params={})
+      build_request(:method => 'POST', :path => path, :body => doc, :params => params)
+    end
+    
+    def put(path, doc, params={})
+      build_request(:method => 'PUT', :path => path, :body => doc, :params => params)
+    end
+    
+    def default_request_params
+      {
+        :account => @account,
+        :secret => @secret,
+        :scheme => @secure ? 'https' : 'http',
+      }
+    end
+    
+    def send_request(request, content_type=nil)
+      response = execute_request(request.method, request.url, request.headers, request.body, content_type)
+      status_code = response.first
+      if (200..299).include?(status_code)
+        begin
+          result = JSON.parse(response.last)
+        rescue JSON::ParserError => e
+          result = {"REASON" => e.message}
+        end
+      else
+        result = {"REASON" => "Error: #{status_code} #{Rack::Utils::HTTP_STATUS_CODES[status_code]}"}
+      end
+      result.merge!({'STATUS' => status_code})
+    end
+
+    def execute_request(method, url, headers, body, content_type=nil)
+      content_type ||= CONTENT_TYPES[:json]
+      curl = Curl::Easy.new(url) do |c|
+        c.headers = headers
+        c.headers['Content-Type'] = content_type
+        c.encoding = 'gzip'
+      end
+      case method
+      when 'GET'
+        curl.http_get
+      when 'DELETE'
+        curl.http_delete
+      when 'POST'
+        curl.http_post(body)
+      when 'PUT'
+        curl.http_put(body)
+      end
+      
+      [curl.response_code, curl.header_str, curl.body_str]
+    end
+
+    def url_pipe_join(arr, default_value='*')
+      arr = Array(arr).flatten
+      if arr.empty?
+        default_value
+      else
+        Rack::Utils.escape(arr.join('|'))
+      end
+    end
+    
+    def identify_documents(docs)
+      [docs] if docs.is_a?(Hash)
+      if @document_id_method
+        docs.each { |d| d.send(@document_id_method) }
+      end
+      docs
+    end
+  end
+end

data/lib/cloud_query/crypto.rb

@@ -0,0 +1,28 @@
+module CloudQuery
+  module Crypto
+    module Random
+      extend self
+
+      SecureRandom = (defined?(::SecureRandom) && ::SecureRandom) || (defined?(::ActiveSupport::SecureRandom) && ::ActiveSupport::SecureRandom)
+      if SecureRandom
+        def nonce
+          "#{SecureRandom.random_number}.#{Time.now.to_i}"[2..-1]
+        end
+      else
+        def nonce
+          "#{rand.to_s}.#{Time.now.to_i}"[2..-1]
+        end
+      end
+    end
+
+    module URLSafeSHA1
+      extend self
+
+      def sign(*tokens)
+        tokens = tokens.flatten
+        digest = Digest::SHA1.digest(tokens.join)
+        Base64.encode64(digest).chomp.tr('+/', '-_')
+      end
+    end
+  end
+end

data/lib/cloud_query/field.rb

@@ -0,0 +1,22 @@
+module CloudQuery
+  class Field
+    attr_accessor :name, :type, :usage
+    
+    def initialize(name, type)
+      @name, @type = name, type
+    end
+    
+    def to_node(builder)
+      builder.field attributes
+    end
+    
+    private
+    
+    def attributes
+      hash = { :name => @name, :type => @type }
+      hash[:usage] = @usage unless @usage.nil?
+      
+      hash
+    end
+  end
+end

data/lib/cloud_query/request.rb

@@ -0,0 +1,64 @@
+module CloudQuery
+  class Request
+    attr_accessor :method, :headers, :scheme, :host, :port, :path, :params, :body
+
+    def initialize(options={})
+      @method = options[:method] || 'POST'
+      @headers = options[:headers] || {}
+      @scheme = options[:scheme] || SCHEME
+      @host = options[:host] || HOST
+      @port = options[:port] || (@scheme == 'https' ? URI::HTTPS::DEFAULT_PORT : URI::HTTP::DEFAULT_PORT)
+      @path = options[:path] || PATH
+      @params = options[:params] || {}
+      if ['PUT', 'DELETE'].include?(@method)
+        @params['_method'] = @method
+        @method = 'POST'
+      end
+      @body = options[:body]
+      
+      @account = options[:account]
+      @secret = options[:secret]
+    end
+
+    def request_uri(account=@account, secret=@secret)
+      query = query_str(signature_params(account))
+      uri = if query.empty?
+        @path.dup
+      else
+        "#{@path}?#{query}"
+      end
+      uri = append_signature(uri, secret) if secret
+      uri
+    end
+
+    def url(account=@account, secret=@secret)
+      base_uri.merge(request_uri(account, secret)).to_s
+    end
+
+    private
+    def append_signature(uri, secret)
+      sig = Crypto::URLSafeSHA1.sign(secret, uri)
+      x_sig = Rack::Utils.build_query("x_sig" => sig)
+      "#{uri}&#{x_sig}"
+    end
+
+    def signature_params(account=@account)
+      return {} unless account
+      {
+        'x_name' => account,
+        'x_time' => Time.now.to_i_milliseconds,
+        'x_nonce' => CloudQuery::Crypto::Random.nonce,
+        'x_method' => SIGNING_METHOD,
+      }
+    end
+
+    def query_str(additional_params={})
+      Rack::Utils.build_query(@params.dup.merge(additional_params))
+    end
+
+    def base_uri
+      uri_class = (@scheme == 'https' ? URI::HTTPS : URI::HTTP)
+      uri_class.build(:scheme => @scheme, :host => @host, :port => @port)
+    end
+  end
+end

data/lib/cloud_query/schema.rb

@@ -0,0 +1,18 @@
+module CloudQuery
+  class Schema
+    attr_accessor :name, :fields
+    
+    def initialize(name)
+      @name   = name
+      @fields = []
+    end
+    
+    def to_xml
+      Nokogiri::XML::Builder.new { |doc|
+        doc.schema(:name => @name, :store => 'yes') {
+          @fields.each { |field| field.to_node(doc) }
+        }
+      }.to_xml
+    end
+  end
+end

data/lib/cloud_query/x64.rb

@@ -0,0 +1,42 @@
+module CloudQuery
+  class X64
+    Shift         = 6
+    Mask          = 0x3f
+    Munge         = 0x30
+    NumberOfChars = (64 + Shift - 1)/Shift
+    Maximum       = 0xffffffffffffffff
+    Compliment    = 0x8000000000000000
+    Characters    = '.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz'
+    
+    def self.encode(object, characters = Characters, munge = Munge)
+      int = integer_from_object(object)
+
+      chars = []
+      while chars.length == 0 || int != 0
+        byte = int & Maximum
+
+        (0...NumberOfChars).each do |i|
+          index = byte & Mask
+          index |= munge if i == (NumberOfChars - 1)
+          chars.unshift characters[index, 1]
+          byte = (byte >> Shift) & Maximum
+        end
+
+        int = int >> 64
+      end
+
+      chars.join
+    end
+    
+    private
+    
+    def self.integer_from_object(object)
+      case object
+      when String
+        UUIDTools::UUID.parse_raw(Digest::MD5.digest(object)).to_i
+      else
+        object.to_i
+      end
+    end
+  end
+end

data/lib/cloud_query.rb

@@ -6,12 +6,14 @@ require "rack/utils"
 require "curl"
 require "json"
 require 'nokogiri'
+require 'uuidtools'
 
 require 'cloud_query/client'
 require 'cloud_query/crypto'
 require 'cloud_query/field'
 require 'cloud_query/request'
 require 'cloud_query/schema'
+require 'cloud_query/x64'
 
 module CloudQuery
   SCHEME  = "https".freeze
@@ -37,7 +39,7 @@ module CloudQuery
 end
 
 class Time
-  def to_i_with_milliseconds
+  def to_i_milliseconds
     (to_f * 1000).to_i
   end
 end

data/spec/cloudquery_spec.rb

@@ -89,7 +89,7 @@ if ENV["TEST_REAL_HTTP"]
             'spec.example.email' => ['steve.rogers@example.com','captain.america@marvel.com'],
             'spec.example.telephone' => ['555-555-5555','123-456-6789'],
             'spec.example.address' => ['Lower East Side, NY NY'],
-            'spec.example.birthday' => ParseDate.parsedate('July 4, 1917'),
+            'spec.example.birthday' => Date.parse('July 4, 1917'),
             'spec.example.note' => 'Captain America!',
         }
       end
@@ -125,7 +125,7 @@ if ENV["TEST_REAL_HTTP"]
             'spec.example.telephone' => ['555-123-1234', '555-456-6789'],
             'spec.example.address' => 
               ['344 Clinton St., Apt. #3B, Metropolis', 'The Fortess of Solitude, North Pole'],
-            'spec.example.birthday' => ParseDate.parsedate('June 18, 1938'),
+            'spec.example.birthday' => Date.parse('June 18, 1938'),
             'spec.example.note' => 
               'Superhuman strength, speed, stamina, durability, senses, intelligence, regeneration, and longevity; super breath, heat vision, x-ray vision and flight. Member of the justice league.',
           },
@@ -135,7 +135,7 @@ if ENV["TEST_REAL_HTTP"]
             'spec.example.telephone' => ['555-123-6666', '555-456-6666'],
             'spec.example.address' => 
               ['1007 Mountain Drive, Gotham', 'The Batcave, Gotham'],
-            'spec.example.birthday' => ParseDate.parsedate('February 19, 1939'),
+            'spec.example.birthday' => Date.parse('February 19, 1939'),
             'spec.example.note' => 
               'Sidekick is Robin. Has problems with the Joker. Member of the justice league.',
           },

data/spec/lib/cloud_query/field_spec.rb

@@ -0,0 +1,43 @@
+require 'spec/spec_helper'
+
+describe CloudQuery::Field do
+  it "should initialize with a name and type" do
+    field = CloudQuery::Field.new(:name, :string)
+    
+    field.name.should == :name
+    field.type.should == :string
+  end
+  
+  describe "#.to_node" do
+    before :each do
+      @field = CloudQuery::Field.new(:name, :string)
+      @builder = Nokogiri::XML::Builder.new { |doc|
+        @field.to_node(doc)
+      }
+    end
+    
+    it "should append a field element" do
+      @builder.doc.at('field').should_not be_nil
+    end
+    
+    it "should set the name attribute" do
+      @builder.doc.at('field')['name'].should == 'name'
+    end
+    
+    it "should set the type attribute" do
+      @builder.doc.at('field')['type'].should == 'string'
+    end
+    
+    it "should set the usage attribute if one is provided" do
+      @field.usage = 'user'
+      @builder = Nokogiri::XML::Builder.new { |doc|
+        @field.to_node(doc)
+      }
+      @builder.doc.at('field')['usage'].should == 'user'
+    end
+    
+    it "should not have a usage attribute if not set" do
+      @builder.doc.at('field')['usage'].should be_nil
+    end
+  end
+end

data/spec/lib/cloud_query/schema_spec.rb

@@ -0,0 +1,34 @@
+require 'spec/spec_helper'
+
+describe CloudQuery::Schema do
+  describe "#.to_xml" do
+    before :each do
+      @schema = CloudQuery::Schema.new('user.schema')
+      @schema.fields << CloudQuery::Field.new(:name,        :string)
+      @schema.fields << CloudQuery::Field.new(:type,        :literal)
+      @schema.fields << CloudQuery::Field.new(:description, :text)
+      
+      @document = Nokogiri::XML(@schema.to_xml)
+    end
+    
+    it "should output a schema element" do
+      @document.at('schema').should_not be_nil
+    end
+    
+    it "should output the schema name as an attribute" do
+      @document.at('schema')['name'].should == 'user.schema'
+    end
+    
+    it "should output the store attribute set to yes" do
+      @document.at('schema')['store'].should == 'yes'
+    end
+    
+    it "should output each of the fields as elements" do
+      @schema.fields.each do |field|
+        @document.at('schema').css('field').detect { |element|
+          element['name'] == field.name.to_s
+        }.should_not be_nil
+      end
+    end
+  end
+end

data/spec/lib/cloud_query/x64_spec.rb

@@ -0,0 +1,14 @@
+require 'spec/spec_helper'
+
+describe CloudQuery::X64 do
+  describe '.encode' do
+    # Built with the expectation of parity with the Python equivalent.
+    it "should return expected values from strings" do
+      CloudQuery::X64.encode('test').should == 'kaEPwp57SCnwfTIcBa8vIq'
+    end
+    
+    it "should return expected values from integers" do
+      CloudQuery::X64.encode(111).should == 'k........0j'
+    end
+  end
+end

data/tasks/distribution.rb

@@ -0,0 +1,38 @@
+require 'jeweler'
+require 'yard'
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new do |t|
+  config  = YAML.load(File.read('VERSION.yml'))
+  version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  
+  t.name  = "CloudQuery #{version}"
+  t.files = ['lib/**/*.rb']
+end
+
+task :rdoc => :yardoc
+
+Jeweler::Tasks.new do |gem|
+  gem.name        = "cloud_query"
+  gem.summary     = "Client for Xoopit's CloudQuery API"
+  gem.description = "Client for Xoopit's CloudQuery API"
+  gem.email       = "cloudquery@xoopit.com"
+  gem.homepage    = "http://github.com/xoopit/cloudquery_ruby"
+  gem.authors     = ["Xoopit", "Cameron Walters", "nb.io", "Pat Allan"]
+  gem.files       = FileList[
+    "lib/**/*.rb",
+    "LICENCE",
+    "README.markdown",
+    "tasks/**/*.rb"
+  ]
+  gem.test_files  = FileList["spec/**/*_spec.rb"]
+  # gem.rubyforge_project = "cloudquery"
+  
+  gem.add_dependency 'rack',      '>= 1.0'
+  gem.add_dependency 'json',      '>= 1.1.4'
+  gem.add_dependency 'taf2-curb', '>= 0.2.8.0'
+  gem.add_dependency 'nokogiri',  '>= 1.3.1'
+  gem.add_dependency 'uuidtools', '>= 2.0.0'
+  
+  # See http://www.rubygems.org/read/chapter/20 for additional gemspec settings
+end

data/tasks/testing.rb

@@ -0,0 +1,14 @@
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts << "-c"
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.spec_opts << "-c"
+  
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
+  t.rcov      = true
+end

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: xoopit-cloud_query
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
+- Xoopit
 - Cameron Walters
 - nb.io
+- Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -07:00
+date: 2009-07-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,8 +45,28 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.2.8.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
 description: Client for Xoopit's CloudQuery API
-email: us@nb.io
+email: cloudquery@xoopit.com
 executables: []
 
 extensions: []
@@ -53,17 +75,20 @@ extra_rdoc_files:
 - LICENSE
 - README.markdown
 files: 
-- LICENSE
 - README.markdown
-- Rakefile
-- VERSION.yml
-- lib/cloudquery.rb
 - lib/cloud_query.rb
-- spec/cloudquery_spec.rb
-- spec/example_schema.xml
-- spec/spec_helper.rb
+- lib/cloud_query/client.rb
+- lib/cloud_query/crypto.rb
+- lib/cloud_query/field.rb
+- lib/cloud_query/request.rb
+- lib/cloud_query/schema.rb
+- lib/cloud_query/x64.rb
+- lib/cloudquery.rb
+- tasks/distribution.rb
+- tasks/testing.rb
+- LICENSE
 has_rdoc: true
-homepage: http://github.com/nbio/cloudquery
+homepage: http://github.com/xoopit/cloudquery_ruby
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -87,7 +112,9 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Client for Xoopit's cloudquery API
+summary: Client for Xoopit's CloudQuery API
 test_files: 
 - spec/cloudquery_spec.rb
-- spec/spec_helper.rb
+- spec/lib/cloud_query/field_spec.rb
+- spec/lib/cloud_query/schema_spec.rb
+- spec/lib/cloud_query/x64_spec.rb

data/Rakefile

@@ -1,80 +0,0 @@
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "cloud_query"
-    gem.summary = "Client for Xoopit's CloudQuery API"
-    gem.email = "us@nb.io"
-    gem.homepage = "http://github.com/xoopit/cloudquery_ruby"
-    gem.description = "Client for Xoopit's CloudQuery API"
-    gem.authors = ["Cameron Walters", "nb.io"]
-    gem.files =  FileList["[A-Z]*", "{lib,spec}/**/*"] 
-    # gem.rubyforge_project = "cloudquery"
-    gem.add_dependency('rack', ">= 1.0")
-    gem.add_dependency('json', ">= 1.1.4")
-    gem.add_dependency('taf2-curb', ">= 0.2.8.0")
-    
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-  spec.spec_opts << "-c"
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "CloudQuery #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-# begin
-#   require 'rake/contrib/sshpublisher'
-#   namespace :rubyforge do
-#     
-#     desc "Release gem and RDoc documentation to RubyForge"
-#     task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-#     
-#     namespace :release do
-#       desc "Publish RDoc to RubyForge."
-#       task :docs => [:rdoc] do
-#         config = YAML.load(
-#             File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-#         )
-# 
-#         host = "#{config['username']}@rubyforge.org"
-#         remote_dir = "/var/www/gforge-projects/cloudquery/"
-#         local_dir = 'rdoc'
-# 
-#         Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-#       end
-#     end
-#   end
-# rescue LoadError
-#   puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-# end

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 0
-:minor: 1
-:patch: 5

data/spec/example_schema.xml

@@ -1,26 +0,0 @@
-<schema name="spec.example" store="yes">
-    <!-- The full name of the contact -->
-    <field name="name"
-           type="string"
-           analyzer="LCWhitespaceAnalyzer"
-           usage="user" />
-    <!-- The email addresses. A json array: email address -->
-    <field name="email"
-           type="string"
-           usage="user" />
-    <!-- The phone numbers. A json array: phone number -->
-    <field name="telephone"
-           type="string"
-           usage="user" />
-    <!-- The addresses. A json array: address -->
-    <field name="address"
-           type="string"
-           usage="user" />
-    <!-- The birthday of the contact-->
-    <field name="birthday"
-           type="date" />
-    <!-- A note for the contact-->
-    <field name="note"
-           type="text"
-           usage="user" />
-</schema>

data/spec/spec_helper.rb

@@ -1,11 +0,0 @@
-require 'spec'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'cloud_query'
-require 'parsedate'
-require 'pp'
-
-Spec::Runner.configure do |config|
-  
-end