KeyholeIO 0.1.1

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/keyholeio.gemspec

@@ -0,0 +1,21 @@
+# -*- 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

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

data/lib/keyholeio.rb

@@ -0,0 +1,305 @@
+# 
+# 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'
+
+# Keyhole.IO API Server
+$http = Net::HTTP.new("api.keyhole.io")
+$version = "v1"
+
+class KeyholeIO
+  attr_accessor :apikey, :token
+  
+  def initialize(apikey, entity_options = nil)
+    @@apikey = apikey
+    unless entity_options.nil?
+      self.register_entity(entity_options)
+    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)
+  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
+
+  # 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"]
+    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
+
+    if [Hash, Array].include?(value.class)
+      val = value.to_json
+    end
+
+    if meta and [Hash, Array].include?(meta.class)
+      met = meta.to_json
+    end
+
+    options = { :k => key, :v => val }
+    options[:meta] = met unless met.nil?
+    self.class.post_data_with_token("/datastore", options)
+  end
+
+  # 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
+
+  # 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
+
+  # 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
+
+
+  # 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
+
+  # GET /group
+  # Lists all entities in a group
+  def get_group(group_name)
+    self.class.get_data_with_apikey("/group", { :id => group_name })
+  end
+
+  # 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)
+  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
+
+  # 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
+
+
+  # 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
+
+  # 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
+
+  # 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
+
+
+  # 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
+
+  # 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
+
+  # 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
+
+  # DELETE /entity/channel
+  # Deletes the channel and stops sending messages to it.
+  def delete_channel
+    self.class.delete_data_with_token("/entity/channel")
+  end
+
+
+  # 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
+
+  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 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
+
+  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 self.get_data(endpoint, options = nil)
+    req = nil
+
+    unless options.nil?
+      req = Net::HTTP::Get.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
+    else
+      req = Net::HTTP::Get.new("/#{$version}#{endpoint}")
+    end
+
+    resp = $http.request(req)
+    JSON.parse(resp.body)
+  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 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 self.delete_data(endpoint, options = nil)
+    req = nil
+
+    unless options.nil?
+      req = Net::HTTP::Delete.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
+    else
+      req = Net::HTTP::Delete.new("/#{$version}#{endpoint}")
+    end
+
+    resp = $http.request(req)
+    JSON.parse(resp.body)
+  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
+
+  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 self.put_data(endpoint, options = nil)
+    req = nil
+
+    unless options.nil?
+      req = Net::HTTP::Put.new("/#{$version}#{endpoint}?".concat(options.to_url_params)) 
+    else
+      req = Net::HTTP::Put.new("/#{$version}#{endpoint}")
+    end
+    req.set_form_data({})
+    resp = $http.request(req)
+    JSON.parse(resp.body)
+  end
+
+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)}"
+    end
+    elements.join("&")
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: KeyholeIO
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- keyholeio.gemspec
+- lib/keyholeio.rb
+- lib/keyholeio/version.rb
+homepage: http://keyhole.io/
+licenses: []
+
+post_install_message: 
+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.8.5
+signing_key: 
+specification_version: 3
+summary: Ruby library for Keyhole.IO's key-value pair database-as-a-service
+test_files: []
+