orchestrate.io 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f161128ca77ed5865e374e9706709583f4a7b363
+  data.tar.gz: 2c396a67015c8778d56bdad2f017774c4a55ae4e
+SHA512:
+  metadata.gz: 594f3cd3c7f64758d4b4be901a0fc41da5022eb0543a2481844a0c22638d6b0250fd74c6a14b639568d62b972086baa9c008fab7bb6a8a5def5b3616f47184e6
+  data.tar.gz: 12231b8ddb65055fafb08fad97872b754b69d4cc889be8b475ff3ae9d39d0cea63318de3217ae99c01b05e5ce6d650ba4dd6f67f61ab80b39701932ea2d1b8bf

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+application.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in orchestrate.io.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 azukiwasher
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 azukiwasher
+
+MIT License
+
+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/README.md

@@ -0,0 +1,108 @@
+# ruby-orchestrate.io
+
+A Ruby interface to the [Orchestrate.io](https://orchestrate.io/) API
+
+[![Build
+Status](https://travis-ci.org/azukiwasher/ruby-orchestrate.io.png?branch=master)](https://travis-ci.org/azukiwasher/ruby-orchestrate.io)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'orchestrate.io'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install orchestrate.io
+```
+
+## Usage
+
+```
+require 'orchestrate.io'
+require 'json'
+
+@io = OrchestrateIo.new(api_key: 'abc')
+@json_data = JSON.dump({a: 1})
+@search_query = "hello dolly"
+```
+
+#### Key/Value
+
+```
+@io.key_value :put do
+  collection "foo"
+  key        "bar"
+　timestamp   1384224213
+  data        @json_data
+end.perform
+
+@io.key_value :get do
+  collection "foo"
+  key        "bar"
+end.perform
+```
+
+#### Search
+
+```
+@io.search do
+  collection "foo"
+  query       @query_string
+end.perform
+```
+
+#### Events
+
+```
+@io.events :put do
+  collection "foo"
+  key        "bar"
+  type       "log"
+　timestamp   1384224213
+  data        @json_data
+end.perform
+
+@io.events :get do
+  collection "foo"
+  key        "bar"
+  type       "log"
+　start       1384224210
+　end         1384224213
+end.perform
+```
+
+#### Graph
+
+```
+@io.graph :put do
+  collection    "foo"
+  key           "bar1"
+  relation      "friends"
+  to_collection "hoge"
+  to_key        "bar2"
+end.perform
+
+@io.graph :get do
+  collection "foo"
+  key        "bar1"
+  relation   "friends"
+end.perform
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/orchestrate.io

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'orchestrate.io'
+
+# Write CLI ...

data/lib/orchestrate.io/client.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require 'httparty'
+require 'orchestrate.io/helper'
+require 'orchestrate.io/configuration'
+require 'orchestrate.io/key_value'
+require 'orchestrate.io/search'
+require 'orchestrate.io/events'
+require 'orchestrate.io/graph'
+require 'orchestrate.io/request'
+
+module OrchestrateIo
+  class Client
+    include HTTParty
+    include Helper
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(attrs={})
+      attrs = OrchestrateIo.options.merge(attrs)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |k|
+        instance_variable_set("@#{k}".to_sym, attrs[k])
+      end
+
+      initialize_client
+      logger.level = verbose ? ::Logger::DEBUG : ::Logger::INFO
+    end
+
+    ##
+    # Updates HTTParty default settings
+    #
+    def initialize_client
+      self.class.format   :json
+      self.class.base_uri endpoint
+      self.class.headers  request_headers
+    end
+
+    ##
+    # Entry point to HTTP request
+    # Set the username of basic auth to the API Key attribute.
+    #
+    def request(http_method, uri, options={})
+      response = self.class.__send__(http_method, uri, options.merge(basic_auth))
+      # Add some logger.debug here ...
+      response
+    end
+
+    def method_missing(name, *args, &block)
+      OrchestrateIo.const_get(name.to_s.camelize!).new(self, args.first, &block)
+    end
+
+  protected
+
+    def basic_auth
+      { basic_auth: { username: api_key, password: "" } }
+    end
+  end
+end

data/lib/orchestrate.io/configuration.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'orchestrate.io/version'
+
+module OrchestrateIo
+  module Configuration
+
+    DEFAULT_REQUEST_HEADERS = {
+      "User-Agent"      => "Orchestrate.io Ruby Gem #{OrchestrateIo::Version}",
+      "Content-Type"    => "application/json; charset=utf-8",
+      "Accept-Language" => "ja,en"
+    }
+
+    DEFAULT_ENDPOINT = "https://api.orchestrate.io"
+
+    VALID_OPTIONS_KEYS = [
+      :request_headers,
+      :endpoint,
+      :api_key,
+      :version,
+      :verbose
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each {|k| options[k] = send(k)}
+      options
+    end
+
+    def reset
+      self.request_headers = DEFAULT_REQUEST_HEADERS
+      self.endpoint        = DEFAULT_ENDPOINT
+      self.api_key         = ""
+      self.version         = "v0"
+      self.verbose         = false
+    end
+  end
+end

data/lib/orchestrate.io/core_ext/string.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+class String
+  def camelize
+    dup.tap &:camelize!
+  end
+
+  def camelize!
+    self.replace(self.split("_").each {|s| s.capitalize! }.join(""))
+  end
+
+  def underscore
+    dup.tap &:underscore!
+  end
+
+  def underscore!
+    self.replace(self.scan(/[A-Z][a-z]*/).join("_").downcase)
+  end
+end

data/lib/orchestrate.io/core_ext.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].each do |path|
+  require path
+end

data/lib/orchestrate.io/events.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class Events
+
+    attr_reader :request
+
+    # == Usage
+    #
+    # io = OrchestrateIo.new(api_key: "abc")
+    # request = io.events :get do
+    #   collection  'films'
+    #   key         'the_godfather'
+    #   type        'comments'
+    # end
+    #
+    # request.perform
+    # => HTTParty::Response
+    #
+    def initialize(client, method, &block)
+      args = {
+        client: client,
+        http_method: method,
+        uri: uri,
+        options: options
+      }
+
+      @request = OrchestrateIo::Request.new(args, &block)
+    end
+
+    def perform
+      request.perform
+    end
+
+  protected
+
+    def uri
+      "/:version/:collection/:key/events/:type"
+    end
+
+    def options
+      options = {}
+      options[:body] = :data
+      options
+    end
+  end
+end

data/lib/orchestrate.io/graph.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class Graph
+
+    attr_reader :request, :http_method
+
+    # == Usage
+    #
+    # io = OrchestrateIo.new(api_key: "abc")
+    # request = io.graph :get do
+    #   collection  'films'
+    #   key         'the_godfather'
+    #   relation    'sequel'
+    # end
+    #
+    # request.perform
+    # => HTTParty::Response
+    #
+    def initialize(client, method, &block)
+      @http_method = method
+      args = {
+        client: client,
+        http_method: method,
+        uri: uri,
+        options: options
+      }
+
+      @request = OrchestrateIo::Request.new(args, &block)
+    end
+
+    def perform
+      request.perform
+    end
+
+  protected
+
+    def uri
+      case http_method
+      when :get
+        "/:version/:collection/:key/relations/:relation"
+      when :put
+        "/:version/:collection/:key/relations/:relation/:to_collection/:to_key"
+      end
+    end
+
+    def options
+      options = {}
+      options
+    end
+  end
+end

data/lib/orchestrate.io/helper.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  module Helper
+
+    ##
+    # Returns current time in millisecond
+    #
+    def current_time
+      Time.now.instance_eval { self.to_i * 1000 + (usec/1000) }
+    end
+
+    ##
+    # Alias for ::Logging.logger
+    #
+    def logger
+      OrchestrateIo.logger
+    end
+  end
+end

data/lib/orchestrate.io/key_value.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class KeyValue
+
+    attr_reader :request
+
+    # == Usage
+    #
+    # io = OrchestrateIo.new(api_key: "abc")
+    # request = io.key_value :get do
+    #   collection  'films'
+    #   key         'kurosawa'
+    # end
+    #
+    # request.perform
+    # => HTTParty::Response
+    #
+    def initialize(client, method, &block)
+      args = {
+        client: client,
+        http_method: method,
+        uri: uri,
+        options: options
+      }
+
+      @request = OrchestrateIo::Request.new(args, &block)
+    end
+
+    def perform
+      request.perform
+    end
+
+  protected
+
+    def uri
+      "/:version/:collection/:key"
+    end
+
+    def options
+      options = {}
+      options[:body] = :data
+      options
+    end
+  end
+end

data/lib/orchestrate.io/logging.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'time'
+require 'logger'
+
+module OrchestrateIo
+  module Logging
+    class Pretty < Logger::Formatter
+      def call(severity, time, program_name, message)
+        "#{time.utc.iso8601} #{Process.pid} #{severity}: #{message}\n"
+      end
+    end
+
+    class << self
+      def initialize_logger(log_target = STDOUT)
+        @logger = Logger.new(log_target)
+        @logger.level = Logger::INFO
+        @logger.formatter = Pretty.new
+        @logger
+      end
+
+      def logger
+        @logger || initialize_logger
+      end
+
+      def logger=(log)
+        @logger = (log ? log : Logger.new('/dev/null'))
+      end
+    end
+
+    def logger
+      OrchestrateIo::Logging.logger
+    end
+  end
+end

data/lib/orchestrate.io/request.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class Request
+    attr_reader :client, :version, :http_method
+
+    def initialize(args, &block)
+      @client      = args[:client]
+      @http_method = args[:http_method]
+      @uri         = args[:uri]
+      @options     = args[:options]
+      @version     = client.version
+
+      instance_eval &block if block_given?
+   end
+
+    def perform
+      client.request(http_method, uri, parse_options(@options))
+    end
+
+    def uri
+      @uri.split(/\//).map {|str|
+        str =~ /^:/ ? instance_variable_get("@" + str.gsub!(/:/,'')) : str
+      }.join("/")
+    end
+
+    def parse_options(options)
+      options.each {|k,v|
+        if v.is_a? Hash
+          parse_options(v)
+        else
+          if value = instance_variable_get("@#{v}")
+            options[k] = value
+          else
+            options.delete(k)
+          end
+        end
+      }
+    end
+
+    def method_missing(method, *args, &block)
+      args = args.first
+      self.class.class_eval do
+        define_method method do |value|
+          instance_variable_set("@#{method}", value)
+        end
+      end
+      self.__send__(method, args)
+    end
+  end
+end

data/lib/orchestrate.io/search.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  class Search
+
+    attr_reader :request
+
+    # == Usage
+    #
+    # io = OrchestrateIo.new(api_key: "abc")
+    # request = io.search :get do
+    #   collection  'films'
+    #   query       'Genre:crime'
+    # end
+    #
+    # request.perform
+    # => HTTParty::Response
+    #
+    def initialize(client, method, &block)
+      args = {
+        client: client,
+        http_method: method,
+        uri: uri,
+        options: options
+      }
+
+      @request = OrchestrateIo::Request.new(args, &block)
+    end
+
+    def perform
+      request.perform
+    end
+
+  protected
+
+    def uri
+      "/:version/:collection"
+    end
+
+    def options
+      options = {}
+      options[:query] = { query: :query }
+      options
+    end
+  end
+end

data/lib/orchestrate.io/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module OrchestrateIo
+  Version = VERSION = "0.1.3"
+end

data/lib/orchestrate.io.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'orchestrate.io/client'
+require 'orchestrate.io/configuration'
+require 'orchestrate.io/logging'
+require 'orchestrate.io/core_ext'
+
+module OrchestrateIo
+  extend Configuration
+
+  def self.new(attrs={})
+    OrchestrateIo::Client.new(attrs)
+  end
+
+  def self.logger
+    OrchestrateIo::Logging.logger
+  end
+
+  def self.logger=(log)
+    OrchestrateIo::Logging.logger = log
+  end
+end