KeyholeIO 0.1.1 → 0.2

data/lib/keyholeio.rb

@@ -1,305 +1,337 @@
-# 
-# Keyhole.IO Ruby API
-# http://keyhole.io/developer/libraries
-#
-# By Kishyr Ramdial <kishyr@immedia.co.za>
-# Revision date: 28 June 2011
-#
-
-require 'rubygems'
-require 'cgi'
-require 'json'
 require 'net/http'
+require 'json'
 
-# Keyhole.IO API Server
-$http = Net::HTTP.new("api.keyhole.io")
-$version = "v1"
+module KeyholeIO
+  APIURL = "http://api.keyhole.io/v1"
 
-class KeyholeIO
-  attr_accessor :apikey, :token
-  
-  def initialize(apikey, entity_options = nil)
-    @@apikey = apikey
-    unless entity_options.nil?
-      self.register_entity(entity_options)
+
+  class Response
+    attr_accessor :meta, :data
+    
+    def initialize response
+      resp = JSON.parse response
+      @meta = resp["meta"]
+      if @meta["status"] >= 200 and @meta["status"] <= 299
+        @data = resp["data"]
+      end
     end
-  end
-  
-  # Entities
-  #
-  # POST /entity
-  # Creates an entity if it doesn't exist and returns a token. If an already exists, it'll return a new token.  
-  def register_entity(options)
-    raw_response = self.class.post_data_with_apikey("/entity", options)
-    if raw_response["meta"]["status"].to_i == 200
-      @@token = raw_response["data"]["token"]
-    end
-    raw_response
-  end
 
-  # GET /entity
-  # Check if an entity exists, and return its description and its channel (if set) if it exists.
-  def check_entity(options) 
-    self.class.get_data_with_apikey("/entity", options)
+    def successful?
+      @meta["status"] >= 200 and @meta["status"] <= 299
+    end   
   end
 
-  # DELETE /entity
-  # Deletes an entity and all its datastores.
-  def delete_entity(id)
-    _hash = { :apikey => @@apikey }
-    _identifier = { :id => id }
-    _hash.merge!(_identifier)
-    self.class.delete_data_with_token("/entity", _hash)
-  end
 
-  # PUT /entity
-  # Nullifies the token given preventing further access to its entity and datastores.
-  def nullify_entity_token
-    self.class.put_data_with_token("/entity")
-  end
+  class KVPair
+    attr_accessor :meta, :key, :value, :meta, :created_at, :updated_at, :type, :successful
+
+    def initialize raw_response
+      response = Response.new raw_response
+      if response.successful?
+        @meta = response.meta
+        @key = response.data["key"]
+        @value = response.data["value"]
+        @created_at = response.data["created_at"] if response.data["created_at"]
+        @updated_at = response.data["updated_at"] if response.data["updated_at"]
+        @type = response.data["type"] if response.data["type"]
+        @successful = true
+      else
+        @successful = false
+      end
+    end
 
-  # POST /entity/password
-  def change_password(oldpass, newpass)
-    options = { :old => oldpass, :new => newpass }
-    raw_response = self.class.post_data_with_token("/entity/password", options)
-    if raw_response["meta"]["status"].to_i == 200
-      @@token = raw_response["data"]["token"]
+    def successful?
+      @successful
     end
-    raw_response
   end
 
 
-  # Datastore
-  # 
-  # POST /datastore
-  # Create or update a datastore (set a value to a key)
-  # FIXME: doesn't support binary uploads
-  def set_datastore(key, value, meta = nil)
-    val = value
-    met = meta
+  class Group
+    attr_accessor :id, :apikey
 
-    if [Hash, Array].include?(value.class)
-      val = value.to_json
+    def initialize name, apikey
+      @apikey = apikey
+      @id = name
+
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/group"), paramshash(name)
+      r = Response.new response.body
     end
 
-    if meta and [Hash, Array].include?(meta.class)
-      met = meta.to_json
+    def entities
+      response = Net::HTTP.get URI.parse("#{APIURL}/group?apikey=#{@apikey}&id=#{@id}")
+      Response.new response
     end
 
-    options = { :k => key, :v => val }
-    options[:meta] = met unless met.nil?
-    self.class.post_data_with_token("/datastore", options)
-  end
+    def add entity
+      if entity.class == Entity
+        http = Net::HTTP.new("api.keyhole.io")
+        req = Net::HTTP::Put.new("/v1/group")
+        req.set_form_data apikey: @apikey, id: @id, entity: entity.name
 
-  # GET /datastore
-  # Returns a paginated list of keys and values.
-  def get_all_datastores(options = nil)
-    self.class.get_data_with_token("/datastore", options)
-  end
+        Response.new http.request(req).body
+      else
+        puts "'entity' needs to be of type Entity."
+      end
+    end
 
-  # GET /datastore/key[/nestedkey]
-  # Returns the datastore for the given key or nested key.
-  def get_datastore(key)
-    self.class.get_data_with_token("/datastore/#{key}")
-  end
+    def remove entity
+      if entity.class == Entity
+        http = Net::HTTP.new("api.keyhole.io")
+        req = Net::HTTP::Delete.new("/v1/group?apikey=#{@apikey}&id=#{@id}&entity=#{entity.name}")
+        Response.new http.request(req).body
+      else
+        puts "'entity' needs to be of type Entity."        
+      end
+    end
 
-  # DELETE /datastore/key
-  # Deletes a datastore (and all uploaded files) given a key. There is no undo!
-  def delete_datastore(key)
-    self.class.delete_data_with_token("/datastore/#{key}")
-  end
+    def destroy
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/group/rm?apikey=#{@apikey}&id=#{@id}")
+      Response.new http.request(req).body
+    end
 
+    private
 
-  # Groups
-  #
-  # POST /group
-  # Creates a new group using the apikey and an identifier (id)
-  def create_group(group_name)
-    self.class.post_data_with_apikey("/group", { :id => group_name })
-  end
+    def paramshash name, options = {}
+      self.class.paramshash name, @apikey, options
+    end
 
-  # GET /group
-  # Lists all entities in a group
-  def get_group(group_name)
-    self.class.get_data_with_apikey("/group", { :id => group_name })
-  end
+    def self.paramshash name, apikey, options
+      params = { 
+        apikey: apikey,
+        id: name
+      }
+      options.collect { |k,v| params[k] = v }
 
-  # PUT /group
-  # Adds an entity with identifier to the specified group.
-  def add_entity_to_group(group, entity)
-    options = { :id => group, :entity => entity }
-    self.class.put_data_with_apikey("/group", options)
+      params
+    end
   end
 
-  # DELETE /group
-  # Remove an entity from a specified group.
-  def delete_entity_from_group(group, entity)
-    options = { :id => group, :entity => entity }
-    self.class.delete_data_with_apikey("/group", options)
-  end
+  
+  class Entity
+    attr_accessor :token, :id, :apikey, :name, :channel_name
+
+    ##
+    ## Entity Methods
+    ##
+
+    def initialize name, apikey, options = {}
+      # options: desc, password, public      
+      @apikey = apikey
+      @name = name
+      
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/entity"), paramshash(name, options)
+      r = Response.new response.body
+      if r.successful?
+        @token = r.data["token"]
+      end
+    end
 
-  # DELETE /group/rm
-  # Deletes the specified group completely (but not its entities)
-  def delete_group(group_name)
-    self.class.delete_data_with_apikey("/group/rm", { :id => group_name })
-  end
+    def info options = {}
+      self.class.get_info @name, @apikey, options
+    end
 
+    def destroy
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/entity?token=#{@token}&apikey=#{@apikey}&id=#{@name}")
+      Response.new http.request(req).body
+    end
 
-  # Messaging Clients
-  #
-  # POST /entity/messaging/type
-  # Adds a messaging client to an entity for messaging via Apple Push Notification, email.
-  def add_msg_client(type, client_id)
-    self.class.post_data_with_token("/entity/messaging/#{type}", { :id => client_id })
-  end
+    def nullify_token
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Put.new("/v1/entity")
+      req.set_form_data token: @token
 
-  # GET /entity/messaging/type
-  # Checks if a messaging client of type {type} exists for an entity.
-  def check_msg_client(type, client_id)
-    self.class.get_data_with_token("/entity/messaging/#{type}", { :id => client_id })
-  end
+      Response.new http.request(req).body
+    end
 
-  # DELETE /entity/messaging/type
-  # Deletes a messaging client of type {type}.
-  def delete_msg_client(type, client_id)
-    self.class.delete_data_with_token("/entity/messaging/#{type}", { :id => client_id })
-  end
+    def set_password new_pass
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/entity/password"), tokenparams(new: new_pass)
+      Response.new response.body
+    end
 
+    def change_password old_pass, new_pass
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/entity/password"), tokenparams(old: old_pass, new: new_pass)
+      Response.new response.body
+    end
 
-  # Real-Time Streaming Channels
-  #
-  # POST /entity/channel
-  # Creates a channel and returns a channel name.
-  def create_channel
-    self.class.post_data_with_token("/entity/channel")
-  end
+    def delete key
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/datastore/#{key}?token=#{@token}")
+      Response.new http.request(req).body
+    end
 
-  # GET /entity/channel
-  # Return how many clients are connected to the channel.
-  def total_clients_in_channel
-    self.class.get_data_with_token("/entity/channel")
-  end
+    ##
+    ## Channel Methods
+    ##
 
-  # PUT /entity/channel
-  # Generates a new channel name and returns it.
-  def generate_new_channel_name
-    self.class.put_data_with_token("/entity/channel")
-  end
+    def channel
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/entity/channel"), tokenparams(nil)
+      r = Response.new response.body
+      if r.successful?
+        @channel_name = r.data["name"]
+      end
+    end
 
-  # DELETE /entity/channel
-  # Deletes the channel and stops sending messages to it.
-  def delete_channel
-    self.class.delete_data_with_token("/entity/channel")
-  end
+    def channel_connected
+      response = Net::HTTP.get URI.parse("#{APIURL}/entity/channel?token=#{@token}")
+      Response.new response
+    end
 
+    def channel_rename
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Put.new("/v1/entity/channel")
+      req.set_form_data token: @token
 
-  # Generic Endpoints
-  # POST
-  def self.post_data_with_apikey(endpoint, options = nil)
-    _hash = { "apikey" => @@apikey }
-    _hash.merge!(options) unless options.nil?
-    self.post_data(endpoint, _hash)
-  end
+      r = Response.new http.request(req).body
+      if r.successful?
+        @channel_name = r.data["name"]
+      end
+    end
 
-  def self.post_data_with_token(endpoint, options = nil)
-    _hash = { "token" => @@token }
-    _hash.merge!(options) unless options.nil? unless options.nil?
-    self.post_data(endpoint, _hash)
-  end
+    def channel_destroy
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/entity/channel?token=#{@token}")
+      r = Response.new http.request(req).body
+      if r.successful?
+        @channel_name = nil
+      end
+      r
+    end
 
-  def self.post_data(endpoint, options = nil)
-    req = Net::HTTP::Post.new("/#{$version}#{endpoint}")
-    req.set_form_data(options) unless options.nil?
-    resp = $http.request(req)
-    JSON.parse(resp.body)
-  end
 
-  # GET
-  def self.get_data_with_apikey(endpoint, options = nil)
-    _hash = { "apikey" => @@apikey }
-    _hash.merge!(options)
-    self.get_data(endpoint, _hash)
-  end
+    ##
+    ## Messaging Client Methods
+    ##
 
-  def self.get_data_with_token(endpoint, options = nil)
-    _hash = { "token" => @@token }
-    _hash.merge!(options) unless options.nil?
-    self.get_data(endpoint, _hash)
-  end
+    def add_client id, type
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/entity/messaging/#{type}"), tokenparams(id: id)
+      Response.new response.body
+    end
 
-  def self.get_data(endpoint, options = nil)
-    req = nil
+    def add_email_client id
+      add_client id, "email"
+    end
 
-    unless options.nil?
-      req = Net::HTTP::Get.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
-    else
-      req = Net::HTTP::Get.new("/#{$version}#{endpoint}")
+    def add_apns_client id
+      add_client id, "apns"
     end
 
-    resp = $http.request(req)
-    JSON.parse(resp.body)
-  end
+    def check_client id, type
+      response = Net::HTTP.get URI.parse("#{APIURL}/entity/messaging/#{type}?token=#{@token}&id=#{id}")
+      r = Response.new response
+      if r.successful?
+        r.meta["status"] == 200
+      else
+        false
+      end
+    end
 
-  # DELETE
-  def self.delete_data_with_apikey(endpoint, options = nil)
-    _hash = { "apikey" => @@apikey }
-    _hash.merge!(options) unless options.nil?
-    self.delete_data(endpoint, _hash)
-  end
+    def email_client_exists? id
+      check_client id, "email"
+    end
 
-  def self.delete_data_with_token(endpoint, options = nil)
-    _hash = { "token" => @@token }
-    _hash.merge!(options) unless options.nil? unless options.nil?
-    self.delete_data(endpoint, _hash)
-  end
+    def apns_client_exists? id
+      check_client id, "apns"
+    end
 
-  def self.delete_data(endpoint, options = nil)
-    req = nil
+    def delete_client id, type
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/entity/messaging/#{type}?token=#{@token}&id=#{id}")
+      r = Response.new http.request(req).body
+    end
 
-    unless options.nil?
-      req = Net::HTTP::Delete.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
-    else
-      req = Net::HTTP::Delete.new("/#{$version}#{endpoint}")
+    def remove_email_client id
+      delete_client id, "email"
     end
 
-    resp = $http.request(req)
-    JSON.parse(resp.body)
-  end
+    def remove_apns_client id
+      delete_client id, "apns"
+    end
 
-  # PUT
-  def self.put_data_with_apikey(endpoint, options = nil)
-    _hash = { "apikey" => @@apikey }
-    _hash.merge!(options) unless options.nil?
-    self.put_data(endpoint, _hash)
-  end
+    ## 
+    ## Datastore Methods
+    ## 
+
+    def set kvpair
+      tparams = {}
+      unless kvpair.empty?
+        tparams[:k] = kvpair.keys.first
+        if (kvpair.values.first.class == Array or kvpair.values.first.class == Hash)
+          tparams[:v] = kvpair.values.first.to_json
+        else  
+          tparams[:v] = kvpair.values.first
+        end
+      end
+
+      if kvpair.size > 1
+        tparams[:meta] = kvpair.values.last.to_json
+      end
+
+      response = Net::HTTP.post_form URI.parse("#{APIURL}/datastore"), tokenparams(tparams)
+      Response.new response.body
+    end
 
-  def self.put_data_with_token(endpoint, options = nil)
-    _hash = { "token" => @@token }
-    _hash.merge!(options) unless options.nil?
-    self.put_data(endpoint, _hash)
-  end
+    def datastores options = {}
+      response = Net::HTTP.get URI.parse("#{APIURL}/datastore?#{tokenparams_string(options)}")
+      Response.new response
+    end
 
-  def self.put_data(endpoint, options = nil)
-    req = nil
+    def get key
+      response = Net::HTTP.get URI.parse("#{APIURL}/datastore/#{key}?#{tokenparams_string(nil)}")
+      KVPair.new response
+    end
 
-    unless options.nil?
-      req = Net::HTTP::Put.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
-    else
-      req = Net::HTTP::Put.new("/#{$version}#{endpoint}")
+    def remove key
+      http = Net::HTTP.new("api.keyhole.io")
+      req = Net::HTTP::Delete.new("/v1/datastore/#{key}?token=#{@token}")
+      r = Response.new http.request(req).body
+    end
+
+    ##
+    ## Class Methods
+    ##
+
+    def self.get_info name, apikey, options = {}
+      # options: password
+      response = Net::HTTP.get(URI.parse("#{APIURL}/entity?#{self.paramshash_string(name, apikey, options)}"))
+      Response.new response
+    end
+
+    #private 
+
+    def tokenparams options = {}
+      params = { token: @token }
+      options.collect { |k,v| params[k] = v } unless options.nil?
+      params      
     end
-    req.set_form_data({})
-    resp = $http.request(req)
-    JSON.parse(resp.body)
-  end
 
-end
+    def tokenparams_string options
+      tokenparams(options).collect { |k, v| "#{k}=#{v}" }.join("&")
+    end
+
+    def paramshash name, options = {}
+      self.class.paramshash name, @apikey, options
+    end
+
+    def self.paramshash name, apikey, options
+      params = { 
+        apikey: apikey,
+        id: name
+      }
+      options.collect { |k,v| params[k] = v }
+
+      params
+    end
+
+    def paramshash_string name, options = {}
+      self.class.paramshash_string name, options, @apikey
+    end
 
-class Hash
-  def to_url_params
-    elements = []
-    keys.size.times do |i|
-      elements << "#{CGI::escape(keys[i].to_s)}=#{CGI::escape(values[i].to_s)}"
+    def self.paramshash_string name, apikey, options
+      self.paramshash(name, apikey, options).collect { |k, v| "#{k}=#{v}" }.join("&")
     end
-    elements.join("&")
+
   end
+
 end

metadata

@@ -1,71 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: KeyholeIO
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: '0.2'
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Kishyr Ramdial
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-29 00:00:00 Z
-dependencies: []
-
-description: Connect and utilise Keyhole.IO's key-value pair database using this simple library.
-email: 
-- kishyr@immedia.co.za
+date: 2011-10-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70094479862500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70094479862500
+description: Keyhole.IO, the database-as-a-service that's so iosome, is a real-time,
+  streaming, key-value pair, object-friendly datastore. For you and your apps. This
+  is its official Ruby gem.
+email: kishyr@immedia.co.za
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- Gemfile
-- Rakefile
-- keyholeio.gemspec
+files:
 - lib/keyholeio.rb
-- lib/keyholeio/version.rb
-homepage: http://keyhole.io/
-licenses: []
-
+homepage: http://keyhole.io/developer
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Ruby library for Keyhole.IO's key-value pair database-as-a-service
+summary: The Official Keyhole.IO Ruby Gem
 test_files: []
-

data/.gitignore

@@ -1,3 +0,0 @@
-pkg/*
-*.gem
-.bundle

data/Gemfile

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

data/Rakefile

@@ -1,2 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks

data/keyholeio.gemspec

@@ -1,21 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "keyholeio/version"
-
-Gem::Specification.new do |s|
-  s.name        = "KeyholeIO"
-  s.version     = Keyholeio::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Kishyr Ramdial"]
-  s.email       = ["kishyr@immedia.co.za"]
-  s.homepage    = "http://keyhole.io/"
-  s.summary     = %q{Ruby library for Keyhole.IO's key-value pair database-as-a-service}
-  s.description = %q{Connect and utilise Keyhole.IO's key-value pair database using this simple library.}
-
-  #s.rubyforge_project = "keyholeio"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end

data/lib/keyholeio/version.rb

@@ -1,3 +0,0 @@
-module Keyholeio
-  VERSION = "0.1.1"
-end