kynetx_am_api 0.1.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Kynetx Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'rake'

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/kynetx_am_api.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/kynetx_am_api/direct_api.rb'
+require File.dirname(__FILE__) + '/kynetx_am_api/oauth.rb'
+require File.dirname(__FILE__) + '/kynetx_am_api/user.rb'
+require File.dirname(__FILE__) + '/kynetx_am_api/application.rb'
+
+
+DEFAULT_META = <<-KRL
+  meta {
+    name "<<NAME>>"
+    description <<
+      <<DESCRIPTION>>
+    >>
+    author ""
+    // Uncomment this line to require Markeplace purchase to use this app.
+    // authz require user
+    logging off
+  }
+KRL
+
+DEFAULT_GLOBAL = <<-KRL
+  global {
+  
+  }
+KRL
+
+DEFAULT_DISPATCH = <<-KRL
+  dispatch {
+    // Some example dispatch domains
+    // www.exmple.com
+    // other.example.com
+  }
+KRL
+
+DEFAULT_RULE = <<-KRL
+  rule <<NAME>> is active {
+    select using "" setting ()
+    // pre {   }
+    // notify("Hello World", "This is a sample rule.");
+    noop();
+  }
+KRL

data/lib/kynetx_am_api/application.rb

@@ -0,0 +1,228 @@
+module KynetxAmApi
+  class Application
+
+    attr_reader :name
+    attr_reader :user
+    attr_reader :application_id
+    attr_reader :api
+
+    def initialize(user, application_id, version=nil)
+      @api = user.api
+      @application_id = application_id
+      @user = user
+      load_base
+    end
+    
+    def to_param
+      return @application_id
+    end
+    
+    def create_initial_app(name, description)
+      @name = name
+      @description = description
+      @meta = DEFAULT_META.gsub("<<NAME>>", name).gsub("<<DESCRIPTION>>", description)
+      @global = DEFAULT_GLOBAL
+      @dispatch = DEFAULT_DISPATCH
+      @first_rule = DEFAULT_RULE.gsub("<<NAME>>", "first_rule")
+      set_krl(gen_default_krl)
+      load_base
+      return self
+    end  
+    
+    def delete
+      @api.post_app_delete(@application_id)      
+    end
+
+    def krl(v=nil)
+      @krl ||= @api.get_app_source(@application_id, v ? v : "development", :krl)
+    end
+    
+    def image_url(size="normal")
+      # returns the image url of a given size
+      load_base unless @images
+      if @images.empty?
+        defaults = {
+          "thumb" => "http://appresource.s3.amazonaws.com/apiappimages/missing_thumb.png",
+          "normal" => "http://appresource.s3.amazonaws.com/apiappimages/missing.png",
+          "original" => "http://appresource.s3.amazonaws.com/apiappimages/missing.png",
+          "icard" => "http://appresource.s3.amazonaws.com/apiappimages/missing_icard.jpg"
+        }
+        return defaults[size.to_s]
+      end
+      return @images[size.to_s]
+    end
+    
+    def set_image(filename, content_type, image_data)
+      return @api.post_app_updateappimage(@application_id, filename, content_type, image_data)
+    end
+    
+    def krl=(krl)
+      set_krl(krl)
+    end
+       
+    def users
+      load_base unless @users
+      return @users
+    end
+    
+    def remove_user(userid)
+      return @api.post_remove_user(@application_id, userid)
+    end
+    
+    def version
+      return development_version
+    end
+    
+    def development_version
+      load_versions unless @development_version
+      return @development_version      
+    end
+
+    def production_version
+      load_versions unless @production_version
+      return @production_version
+    end
+    
+    def production_version=(version)
+      @api.post_app_setproductversion(@application_id, version)
+      @production_version = version
+    end
+    
+    def versions
+      load_versions unless @versions
+      return @versions      
+    end
+    
+    def set_version_note(version, note)
+      @api.post_app_setversionnote(@application_id, version, note)
+    end
+    
+    def owner
+      load_base unless @owner
+      return @owner
+    end
+    
+    def transfer_request
+      load_base unless @transfer_request
+      return @transfer_request
+    end
+    
+    def transfer_owner(user_id, message)
+      load_base unless @name
+      return @api.post_app_transferownershiprequest(@application_id, @name, user_id, message)
+    end
+    
+    def cancel_transfer(request_id)
+      return @api.post_app_ownershiptransfercancel(@application_id, request_id)
+    end
+    
+    def share(email, message)
+      load_base unless @name
+      return @api.post_app_inviteuser(@application_id, @name, email, message)
+    end
+    
+    def invites
+      load_base unless @invites
+      return @invites
+    end
+    
+    def cancel_invite(invite_id)
+      return @api.post_app_invitecancel(@application_id, invite_id)
+    end
+    
+    def reload
+      load_base
+      load_versions
+    end
+    
+    #----- Distrubution Methods
+    
+    def bookmarklet(env="prod", runtime="init.kobj.net/js/shared/kobj-static.js")
+      return @api.post_app_generate(@application_id, "bookmarklet", {"env" => env, "runtime" => runtime})["data"]
+    end
+    
+    def infocard(name, datasets, env="prod")
+      load_base unless @guid
+      options = {
+        "extname" => name.gsub(/[&'<]/, "_"),
+        "extdatasets" => datasets.to_s,
+        "extversion" => env
+      }
+
+      options["image_url"] = image_url("icard")
+      
+      return @api.post_app_generate(@application_id, "info_card", options)
+    end
+    
+    def extension(type, name, author, description)
+      options = {
+        "extname" => name,
+        "extdesc" => description,
+        "extauthor" => author.to_s.empty? ? @user.name : author
+      }
+      options["appguid"] = @guid if type == :ie
+      return @api.post_app_generate(@application_id, type.to_s, options)
+      
+    end
+    
+    private
+  
+    def gen_default_krl
+      r = "ruleset #{@application_id} {\n#{@meta}\n#{@dispatch}\n#{@global}\n#{@first_rule}}"
+      return r
+    end
+    
+    def load_base
+      app_details = @api.get_app_details(@application_id)
+      puts "APPDETAILS: #{app_details.inspect}" if $DEBUG
+      if app_details["error"]
+        raise app_details["error"]
+      end
+      @name = app_details["name"]
+      @application_id = app_details["appid"]
+      @guid = app_details["guid"]
+      @owner = nil
+      @users = app_details["users"]
+      @users.each do |user|
+        if user["role"] == "owner"
+          @owner = user 
+          break
+        end
+      end
+      @transfer_request = app_details["transferrequest"]
+      @transfer_request = nil unless @transfer_request
+      @invites = app_details["invites"]
+      @invites = [] unless @invites
+      @images = app_details["images"]
+      @images = [] unless @images
+    end
+  
+  
+    def load_versions
+      app_info = @api.get_app_info(@application_id)
+      puts "APPINFO: #{app_info.inspect}"  if $DEBUG
+      @production_version = app_info["production"]["version"] if app_info["production"]
+      @development_version = app_info["development"]["version"] if app_info["development"]
+      @application_id = app_info["appid"]
+      @versions = app_info["versions"]
+    end
+    
+    def set_krl(krl)
+      # ensure that the ruleset_id is correct.
+      krl.gsub!(/ruleset.*?\{/m, "ruleset #{@application_id} {")  
+      puts "NEW KRL: #{krl}"  if $DEBUG
+      response = @api.post_app_source(@application_id, krl, "krl")
+      response = JSON.parse(response)
+      if response["valid"]
+        reload
+        return true
+      else
+        raise response["error"]
+      end
+    end
+  
+
+  end
+end
+
+

data/lib/kynetx_am_api/direct_api.rb

@@ -0,0 +1,210 @@
+module KynetxAmApi
+  require 'rubygems'
+  require 'oauth'
+  require 'json'
+  require 'net/http/post/multipart'
+
+  class DirectApi
+
+    attr_accessor :oauth
+
+    #
+    # Create a new session to the KynetxApi Manager.
+    #
+    # request_token
+    # request_secret
+    #     :request_token
+    #     :request_secret
+    #     :oauth_verifier
+    #     :access_token
+    #     :access_secret
+    #
+    def initialize(tokens_and_secrets = {})
+      @oauth = KynetxAmApi::Oauth.new(tokens_and_secrets)
+    end
+
+    #
+    def get_request_token
+      @oauth.get_request_token
+    end
+
+    #
+    # Provides the url to direct user to if the application has not been authorized. 
+    #
+    def get_authorize_url
+      return get_request_token.authorize_url
+    end
+
+
+    #
+    # API Call From Here Down.
+    #
+
+    #
+    #
+    def get_applist
+      return get_response("applist", :json)
+    end
+
+    def get_appcreate
+      return get_response("appcreate", :json)
+    end
+
+    def post_app_delete(application_id)
+      return post_response("app/#{application_id}/delete", {})
+    end
+
+    def post_remove_user(application_id, user_id)
+      return post_response("app/#{application_id}/removeuser", {"userid" => user_id})
+    end
+
+    def post_app_inviteuser(application_id, application_name, email, message)
+      return post_response("app/#{application_id}/inviteuser", {"email" => email, "message" => message, "appname" => application_name.to_s})
+    end
+
+    def post_app_invitecancel(application_id, invite_id)
+      return post_response("app/#{application_id}/invitecancel",{"inviteid" => invite_id})
+    end
+
+    def post_app_transferownershiprequest(application_id,application_name,user_id,message)
+      return post_response("app/#{application_id}/ownershiptransferrequest", {"userid" => user_id, "message" => message, "appname" => application_name})
+    end
+
+    def post_app_ownershiptransfercancel(application_id,transfer_id)
+      return post_response("app/#{application_id}/ownershiptransfercancel", {"ownershiptransferrequestid" => transfer_id})
+    end
+
+    #
+    # type is one of ff = firefox, ie = internet explorer, cr = google chrome
+    #
+    def post_app_generate(application_id, type, opts={})
+            # 
+            # default_options = {
+            #   "name" => "",
+            #   "author" => "",
+            #   "description" => "",
+            #   "guid" => "",
+            #   "datasets" => "",
+            #   "env" => "prod",
+            #   "image_url" => "http://appresource.s3.amazonaws.com/apiappimages/missing_icard.jpg",
+            #   "runtime" => ""
+            # }
+            # options = default_options.merge(opts)
+      return post_response("app/#{application_id}/generate/#{type}", opts,:json)
+    end
+
+
+    def get_app_source(application_id, version, format = :krl)
+      data =  get_response("app/#{application_id}/source/#{version}/#{format}", format)
+      return data
+    end
+
+    def get_app_info(application_id)
+      return get_response("app/#{application_id}/info", :json)
+    end
+    
+    def get_app_details(application_id)
+      return get_response("app/#{application_id}/details", :json)
+    end
+
+
+    def post_app_source(application_id, source, type = "krl")
+      data = ""
+      if type == "krl"
+        data = {:krl => source.to_s}
+      else
+        data = {:json => source.to_json}
+      end
+      return post_response("app/#{application_id}/source", data)
+    end
+
+
+    def post_app_setproductversion(application_id, version)
+      return post_response("app/#{application_id}/setproductionversion", {"version" => version})
+    end
+    
+    def post_app_setversionnote(application_id, version, note)
+      return post_response("app/#{application_id}/setversionnote", {"version" => version, "note" => note}, :json)
+    end
+    
+    def post_app_updateappimage(application_id, filename, content_type, image_data)
+      # TODO: Make this go through the APIß
+      response = ""      
+      url = URI.parse('https://accounts.kynetx.com/api/0.1/updateAppInfo')      
+      StringIO.open(image_data) do |i|
+        req = Net::HTTP::Post::Multipart.new url.path,
+          "image" => UploadIO.new(i, content_type, filename),
+          "appid" => application_id
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        response = http.start { |h| h.request(req) }        
+      end
+      
+      return response
+    end
+
+    def ping
+      return get_response("ping")
+    end
+
+    def get_user_info
+      user = @oauth.user
+      if user.username.to_s.empty?
+        user_info = get_response("userinfo", :json)
+        user.username = user_info["username"]
+        user.userid = user_info["userid"]
+        user.name = user_info["name"]
+      end
+      return user
+    end
+
+    private
+
+    def get_response(api_method, format = nil)
+      if format == :json
+        headers = {'Accept'=>'application/json'}
+      end
+      api_call = "/0.1/#{api_method}"
+      puts "---------GET---------------" if $DEBUG
+      puts api_call  if $DEBUG
+      puts "___________________________"  if $DEBUG
+      response = @oauth.get_access_token.get(api_call, headers).body
+      puts response.inspect if $DEBUG
+      puts "___________________________"  if $DEBUG
+      begin
+        response = JSON.parse(response) if format == :json
+      rescue
+        puts $! if $DEBUG
+        raise "Unexpected response from the api: (#{api_method}) :: #{response}"
+      end
+      return response
+    end
+
+    # Probably a better way to do this.  Make it a little more DRY
+    def post_response(api_method, data, format=nil, additional_headers=nil)
+      if format == :json
+        headers = {'Accept'=>'application/json'}
+      end
+      if additional_headers
+        headers.merge!(additional_headers)
+      end
+      api_call = "/0.1/#{api_method}"
+      puts "---------POST--------------"  if $DEBUG
+      puts api_call  if $DEBUG
+      puts data.inspect if $DEBUG
+      puts "___________________________" if $DEBUG
+      response = @oauth.get_access_token.post(api_call, data, headers).body
+      puts response.inspect if $DEBUG
+      puts "---------------------------" if $DEBUG
+      begin
+        response = JSON.parse(response) if format == :json
+      rescue
+        puts $! if $DEBUG
+        raise "Unexpected response from the api: (#{api_method}) :: #{response}"
+      end
+      return response
+    end
+ 
+    
+  end
+end

data/lib/kynetx_am_api/oauth.rb

@@ -0,0 +1,91 @@
+module KynetxAmApi
+  require 'oauth'
+  require 'json'
+
+  class Oauth
+
+    attr_accessor :request_token
+    attr_accessor :account_consumer
+    attr_accessor :api_consumer
+    attr_accessor :user
+    attr_accessor :access_token
+
+
+    def initialize(user=nil)
+      @user = KynetxAmApi::User.new(user)
+      if @user.oauth_verifier
+        access_tokens
+      end
+    end
+
+    def get_access_token
+      return @access_token if @access_token
+      return @access_token = OAuth::AccessToken.new(get_api_consumer, @user.access_token, @user.access_secret)
+    end
+
+    def get_request_token
+      return @request_token if @request_token
+      return @request_token = get_account_consumer.get_request_token
+    end
+
+
+    def self.accounts_server_url=(v)
+      @@accounts_server_url = v
+    end
+    
+    def self.api_server_url=(v)
+      @@api_server_url = v
+    end
+    
+    def self.consumer_key=(v)
+      @@consumer_key = v
+    end
+    
+    def self.consumer_secret=(v)
+      @@consumer_secret = v
+    end
+
+    private
+
+   
+    def access_tokens
+      access_request_token = OAuth::RequestToken.new(get_account_consumer, @user.request_token, @user.request_secret)
+      access_token_data = access_request_token.get_access_token :oauth_verifier => @user.oauth_verifier
+      @user.access_token = access_token_data.token
+      @user.access_secret = access_token_data.secret
+
+    end
+
+    def get_account_consumer
+      return @account_consumer if @account_consumer
+      return @account_consumer = OAuth::Consumer.new(@@consumer_key, @@consumer_secret, {
+              :site               => @@accounts_server_url,
+              :scheme             => :header,
+              :method             => :get,
+              :request_token_path => "/oauth/request_token",
+              :access_token_path  => "/oauth/access_token",
+              :authorize_path     => "/oauth/authorize",
+              :oauth_version      => "1.0a"
+      })
+
+
+    end
+
+
+    def get_api_consumer
+      return @api_consumer if @api_consumer
+      return @api_consumer = OAuth::Consumer.new(@@consumer_key, @@consumer_secret, {
+              :site               => @@api_server_url,
+              :scheme             => :header,
+              :method             => :get,
+              :request_token_path => "/oauth/request_token",
+              :access_token_path  => "/oauth/access_token",
+              :authorize_path     => "/oauth/authorize",
+              :oauth_version      => "1.0a"
+      })
+
+
+    end
+
+  end
+end

data/lib/kynetx_am_api/user.rb

@@ -0,0 +1,125 @@
+module KynetxAmApi
+  #
+  # Simple wrapper to allow access to the OAuth user information.   This also hold some basic user data like
+  # username, name and user id.
+  #
+  class User
+    # OAuth Request Token
+    attr_accessor :request_token
+    # OAuth Secret Token
+    attr_accessor :request_secret
+    # OAuth Verifieer
+    attr_accessor :oauth_verifier
+    # OAuth Access Token
+    attr_accessor :access_token
+    # OAuth Access Secret
+    attr_accessor :access_secret
+    # Kynetx User name
+    attr_accessor :username
+    # Kynetx User ID
+    attr_accessor :userid
+    # Full name of user
+    attr_accessor :name
+    # Current Application context.
+    attr_reader :current_application
+
+
+    #
+    # Accepts a hash that has the following entries.
+    # - :request_token
+    # - :request_secret
+    # - :oauth_verifier
+    # - :access_token
+    # - :access_secret
+    # - :username
+    # - :userid
+    # - :name
+    #
+
+    def initialize(attributes)
+      @request_token = attributes[:request_token]
+      @request_secret = attributes[:request_secret]
+      @oauth_verifier = attributes[:oauth_verifier]
+      @access_token = attributes[:access_token]
+      @access_secret = attributes[:access_secret]
+      @username = attributes[:username]
+      @userid = attributes[:userid]
+      @name = attributes[:name]
+      @current_applicaion = nil
+    end
+
+    #
+    # Returns the direct api to the Kynetx Application Manager.
+    #
+    def api
+      @api ||= KynetxAmApi::DirectApi.new({:access_token => @access_token, :access_secret => @access_secret})
+      return @api
+    end
+
+    #
+    # Read applications list 
+    #
+    # - :offset => Start in list (not implemented)
+    # - :size => Number of application to list (not implemented)
+    #
+    # Returns a has with two keys
+    # - "apps" => Array Off Hashes with :appid , :role, :name, :created
+    # - "valid" => true
+    #
+    def applications(options = {})
+      @applications = api.get_applist if !@applications
+      @applications
+    end
+
+    #
+    # - :application_id => application_id
+    # - :version => Version of application to obtain
+    #
+    def find_application(options = {})
+      options[:version] ||= "development"
+      raise "Expecting :application_id" unless options[:application_id]
+      
+      if @current_application && @current_application.application_id != options[:application_id]
+        @current_application = KynetxAmApi::Application.new(self, options[:application_id], options[:version])
+      else
+        @current_application ||= KynetxAmApi::Application.new(self, options[:application_id], options[:version])
+      end
+      return @current_application
+    end
+
+
+    def create_application(name, description="")
+      appid = api.get_appcreate["appid"]
+      @current_application = KynetxAmApi::Application.new(self, appid).create_initial_app(name, description)
+      
+      return @current_application
+    end
+    
+    def duplicate_application(application_id)
+      old_app = KynetxAmApi::Application.new(self, application_id)
+      new_app = create_application(old_app.name || "", "")
+      new_app.krl = old_app.krl
+      return new_app
+    end
+    
+    def owns_current?
+      return false unless @current_application
+      return @current_application.owner["kynetxuserid"].to_i == self.userid.to_i
+    end
+    
+    def to_h
+      return {
+        :access_secret => @access_secret,
+        :access_token => @access_token,
+        :request_token => @request_token,
+        :request_secret => @request_secret,
+        :oauth_verifier => @oauth_verifier,
+        :name => @name,
+        :userid => @userid,
+        :username => @username
+      }
+    end
+
+
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/kynetx_am_api.rb"

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: kynetx_am_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Farmer, Cid Dennis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "    Using this gem you can access the Kynetx Application API.  This api allows developers a way\n    to create,update, delete rulesets.   This gem also helps with the required OAuth communcations with\n    the api server.\n"
+email: cid@kynetx.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- lib/kynetx_am_api/application.rb
+- lib/kynetx_am_api/direct_api.rb
+- lib/kynetx_am_api/oauth.rb
+- lib/kynetx_am_api/user.rb
+- lib/kynetx_am_api.rb
+- rails/init.rb
+- init.rb
+- Rakefile
+- LICENSE
+has_rdoc: true
+homepage: http://www.kynetx.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple Gem used to communicate with the Kynetx Application Manager.
+test_files: []
+