orchestrate-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4939042aeb2ca40acfdd9733ac806a16790c0573
+  data.tar.gz: 1f301d012d8d27cb0963c32d0c791d400df29af6
+SHA512:
+  metadata.gz: fc2c245de2d11356de25f1f5bb38f43a55aaf12fa7c33e3eb58d4fe228243741c86e5a45e99dd870124dc62ee6de613375d885f2f23892e5d121106cc7e7dc03
+  data.tar.gz: fc80afd5dad3b27e43aedd09349f4ba4c144cc15a51413a25f17173878b3b2a4ed263b45a573cd0a1487d6ef95c44d1f642518af3eb923a5e887f482805ca5a2

data/lib/orchestrate-api.rb

@@ -0,0 +1,22 @@
+module Orchestrate
+
+=begin rdoc
+  ==== orchestrate-api
+
+  Ruby gem <tt>orchestrate-api</tt> provides an
+  interface to the <b>Orchestrate.io</b> *API*.
+
+  The <b>Wrapper[API/Wrapper.html]</b> class is used to setup the client and make HTTP requests.
+=end
+
+  module API
+
+    # require "active_support/core_ext"
+
+    require "orchestrate_api/procedural"
+    require "orchestrate_api/wrapper"
+    require "orchestrate_api/request"
+    require "orchestrate_api/response"
+
+  end
+end

data/lib/orchestrate_api/procedural.rb

@@ -0,0 +1,107 @@
+module Orchestrate::API
+
+  # ==== *Procedural* interface methods (optional).
+  #
+  # This file serves as useful documentation for the <b>Orchestrate.io REST</b> *API*.
+  # Each method illustrates an example for the corresponding HTTP request,
+  # and documents the required keys for the send_request argument hash.
+  #
+  module Procedural
+
+    # -------------------------------------------------------------------------
+    #  collection
+
+    #  * required: { collection }
+    #
+    def list(args)
+      send_request :get, args
+    end
+
+    #  * required: { collection }
+    #
+    def search(args)
+      send_request :get, args.merge(path: "/?query=#{args[:query].gsub(/\s/, '%20')}")
+    end
+
+    #  * required: { collection }
+    #
+    def delete_collection(args)
+      send_request :delete, args.merge(path: "?force=true")
+    end
+
+    # -------------------------------------------------------------------------
+    #  collection/key
+
+    #  * required: { collection, key }
+    #
+    def get_key(args)
+      send_request :get, args
+    end
+
+    #  * required: { collection, key, json }
+    #
+    def put_key(args)
+      send_request :put, args
+    end
+
+    #  * required: { collection, key }
+    #
+    def delete_key(args)
+      send_request :delete, args
+    end
+
+    # -------------------------------------------------------------------------
+    #  collection/key/ref
+
+    #   * required: { collection, key, ref }
+    #
+    def get_by_ref(args)
+      send_request :get, args
+    end
+
+    #  * required: { collection, key, json, ref }
+    #
+    def put_key_if_match(args)
+      send_request :put, args
+    end
+
+    # * required: { collection, key, json }
+    #
+    def put_key_if_none_match(args)
+      send_request :put, args.merge(ref: '"*"')
+    end
+
+    # -------------------------------------------------------------------------
+    #  collection/key/events
+
+    #  * required: { collection, key, event_type }
+    #  * optional: { timestamp }, where timestamp = { :start => start, :end => end }
+    #
+    def get_events(args)
+      send_request :get, args
+    end
+
+    #  * required: { collection, key, event_type, json }
+    #  * optional: { timestamp }, where timestamp is a scalar value
+    #
+    def put_event(args)
+      send_request :put, args
+    end
+
+    # -------------------------------------------------------------------------
+    #  collection/key/graph
+
+    #  * required: { collection, key, kind }
+    #
+    def get_graph(args)
+      send_request :get, args
+    end
+
+    #  * required: { collection, key, kind, to_collection, to_key }
+    #
+    def put_graph(args)
+      send_request :put, args
+    end
+
+  end
+end

data/lib/orchestrate_api/request.rb

@@ -0,0 +1,63 @@
+module Orchestrate::API
+
+  require 'httparty'
+
+  #  Uses HTTParty to make the HTTP calls,
+  #  and returns a Response object.
+  #
+  class Request < Object
+
+    # The HTTP method - must be one of: [ :get, :put, :delete ].
+    attr_accessor :method
+
+    # The url for the HTTP request.
+    attr_accessor  :url
+
+    # The api key for HTTP Basic Authentication over SSL.
+    attr_accessor :user
+
+    # The json document for creating or updating a key.
+    attr_accessor  :data
+
+    # The ref value associated with a key.
+    attr_accessor  :ref
+
+    # Boolean
+    attr_accessor  :verbose
+
+    # Sets the universal attributes from the params; any additional
+    # attributes are set from the block.
+    #
+    def initialize(method, url, user)
+      @method, @url, @user = method, url, user
+      @data = {}
+      yield self if block_given?
+    end
+
+    # Sends the HTTP request and returns a Response object.
+    def perform
+      puts "\n------- #{method.to_s.upcase} \"#{url}\" ------" if verbose?
+      Response.new HTTParty.send(method, url, options)
+    end
+
+    private
+
+      # Sets up the HTTParty options hash.
+      def options
+        options = { basic_auth: { username: user, password: nil }}
+        if method == :put
+          headers = { 'Content-Type' => 'application/json' }
+          if ref
+            header = ref == '"*"' ? 'If-None-Match' : 'If-Match'
+            headers.merge!(header => ref)
+          end
+          options.merge!(headers: headers, body: data)
+        end
+        options
+      end
+
+      def verbose?
+        verbose == true
+      end
+  end
+end

data/lib/orchestrate_api/response.rb

@@ -0,0 +1,101 @@
+module Orchestrate::API
+
+  # Transforms the HTTParty response into a structure that provides ready
+  # access to relevant orchestrate.io response data.
+  #
+  class Response
+    # Header
+    attr_reader :header
+
+    # ResponseBody
+    attr_reader :body
+
+    # Creates Header and ResponseBody objects from the HTTParty response.
+    # Let's Partay!
+    #
+    def initialize(partay)
+      @success = partay.success?
+      @header = Header.new partay.headers, partay.code, partay.msg
+      @body = ResponseBody.new partay.body
+    end
+
+    # Returns the value of HTTParty.success?
+    def success?
+      @success
+    end
+
+    # Provides methods for ready access to relevant information extracted
+    # from the HTTParty response headers.
+    #
+    class Header
+
+      # Original response headers from HTTParty.
+      attr_reader :content
+
+      # HTTP response code.
+      attr_reader :code
+
+      # HTTP response status.
+      attr_reader :status
+
+      attr_reader :timestamp
+
+      # ETag value, also known as the 'ref' value.
+      attr_reader :etag
+
+      # Link to the next url in a series of list requests.
+      attr_reader :link
+
+      def initialize(headers, code, msg)
+        @content = headers
+        @code, @status = code, msg
+        @timestamp = headers['date']
+        @etag = headers['etag'] if headers['etag']
+        @link = headers['link'] if headers['link']
+      end
+    end
+  end
+
+
+  # Decodes body from json into a hash; provides the original body content
+  # via the 'content' method.
+  #
+  class ResponseBody
+
+    # Original response body from HTTParty.
+    attr_reader :content
+
+    # The json response body converted to a hash.
+    attr_reader :to_hash
+
+    # Set for all results.
+    attr_reader :results
+
+    # Set for list, search, get_events, and get_graph results.
+    attr_reader :count
+
+    # Set for search results.
+    attr_reader :total_count
+
+    # Set for list results.
+    attr_reader :next
+
+    # Error message from the orchestrate.io api.
+    attr_reader :message
+
+    # Error code from the orchestrate.io api.
+    attr_reader :code
+
+    # Initialize instance variables, based on response body contents.
+    def initialize(body)
+      @content = body
+      @to_hash = body.blank? ? {} : ActiveSupport::JSON.decode(body)
+      to_hash.each { |k,v| instance_variable_set "@#{k}", v }
+    end
+
+    def result_keys
+      results.map { |result| result['path']['key'] } if results
+    end
+  end
+
+end

data/lib/orchestrate_api/wrapper.rb

@@ -0,0 +1,83 @@
+module Orchestrate::API
+
+  require "active_support/core_ext"
+
+  # ==== Ruby wrapper for the Orchestrate.io REST *API*.
+  #
+  # The primary entry point is the <b> #send_request</b> method, which
+  # generates a <b> Request</b>, and returns the
+  # <b> Response</b> to the caller.
+  # <b>{Usage examples for each HTTP request}[Procedural.html]</b>
+  # are documented in the <b> Procedural</b> interface module.
+  #
+  class Wrapper < Object
+    include Orchestrate::API::Procedural
+
+    attr_accessor :verbose
+
+    # Loads settings from the configuration file and returns the client
+    # handle to be used for subsequent requests.
+    #
+    #  Example config file: "./lib/orch_config.json"
+    #
+    #   {
+    #     "base_url":"https://api.orchestrate.io/v0",
+    #     "user":"<user-key-from-orchestrate.io>",
+    #     "verbose":"false"
+    #   }
+    #
+    def initialize(config_file)
+      orch_config = ::ActiveSupport::JSON.decode open(config_file).read
+      @base_url = orch_config['base_url']
+      @user     = orch_config['user']
+      @verbose  = orch_config['verbose'] ? orch_config['verbose'] : false
+    end
+
+    # Creates the Request object and sends it via the perform method,
+    # which generates and returns the Response object.
+    #
+    def send_request(method, args)
+      request = Orchestrate::API::Request.new(method, build_url(method, args), @user) do |r|
+        r.data = args[:json] if args[:json]
+        r.ref = args[:ref] if args[:ref]
+        r.verbose = verbose
+      end
+      request.perform
+    end
+
+    private
+
+      # Builds the URL for each HTTP request to the orchestrate.io api.
+      #
+      def build_url(method, args)
+        uri = "#{@base_url}/#{args[:collection]}"
+        if args[:key]
+          uri << "/#{args[:key]}"
+          if args[:ref]
+            uri << "/refs/#{args[:ref].gsub(/"/, '')}" if method == :get
+          elsif args[:event_type]
+            uri << "/events/#{args[:event_type]}"
+            if args[:timestamp]
+              if method == :put && args[:timestamp][:start]
+                uri << "?start=#{args[:timestamp][:start]}&end=#{args[:timestamp][:end]}"
+              elsif method == :get && !args[:timestamp].blank?
+                uri << "?timestamp=#{timestamp}"
+              end
+            end
+          elsif args[:kind]
+            if method == :put
+              uri << "/relation/#{args[:kind]}/#{args[:to_collection]}/#{args[:to_key]}"
+            else
+              uri << "/relations/#{args[:kind]}"
+            end
+          end
+        elsif args[:path]
+          uri << args[:path]
+        end
+        uri
+      end
+
+  end
+end
+
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: orchestrate-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Carrasquer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to interface with orchestrate.io api
+email: jimcar@aracnet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/orchestrate-api.rb
+- lib/orchestrate_api/procedural.rb
+- lib/orchestrate_api/wrapper.rb
+- lib/orchestrate_api/request.rb
+- lib/orchestrate_api/response.rb
+homepage: https://github.com/jimcar/orchestrate-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Summary for orchestrate-api
+test_files: []