reflect 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 928aa43cbfd50fdfcd1843a1233bbf704a45e509
+  data.tar.gz: d5afdd92cf542be18c98a47b02096ef6be285695
+SHA512:
+  metadata.gz: c044b1a3ec63e1110f16af6b69a78569d84d573e39d2e5e3be1907441a8feca2dca3c5715a73f44aac91bd39fb9123e4995be2f2bdfd25cb72d00b34787f5e62
+  data.tar.gz: 322204507bcdbe50df45c8b028a2e31c54303b0d643d8a766fcfb4bd7da6dec045d9dce8f350464a231d489fe3db6b07ad5cbbbbf27e31af60882b26a39a5a7a

data/lib/reflect.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.expand_path("../", __FILE__))
+
+require 'reflect/key_list'
+require 'reflect/request_error'
+require 'reflect/keyspace'
+require 'reflect/field'
+require 'reflect/client'
+
+module Reflect
+  def self._format_error_message(resp)
+    "An error occured with the request. Status: #{resp.response.code} Error: #{_extract_error_message(resp)}"
+  end
+
+  def self._extract_error_message(resp)
+    begin
+      json = JSON.parse(resp.body)
+      json["error"]
+    rescue JSON::ParserError
+      # TODO: Report this?
+      ""
+    end
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new("/dev/null")
+  end
+end

data/lib/reflect/client.rb

@@ -0,0 +1,72 @@
+require 'uri'
+require 'json'
+require 'httparty'
+require 'reflect/version'
+
+module Reflect
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.reflect.io'
+
+    def initialize(token)
+      @token = token
+    end
+
+    def keyspace(slug)
+      res = get("/v1/keyspaces/#{slug}")
+
+      if res.response.code == "200"
+        Keyspace.new(self, JSON.parse(res.body))
+      else
+        # TODO: What happens if we failed to look this up or whatever?
+        raise Reflect::RequestError, Reflect._format_error_message(res)
+      end
+    end
+
+    def get(path)
+      self.class.get(URI.encode(path), options)
+    end
+
+    def post(path, content)
+      self.class.post(URI.encode(path), options(body: dump(content)))
+    end
+
+    def put(path, content)
+      self.class.put(URI.encode(path), options(body: dump(content)))
+    end
+
+    def delete(path)
+      logger.debug { "[reflect] Sending DELETE #{URI.encode(path)}" }
+      self.class.delete(URI.encode(path), options)
+    end
+
+    def patch(path, content, headers={})
+      opts = options(body: dump(content))
+      opts[:headers].merge!(headers) unless headers.empty?
+      self.class.patch(path, opts)
+    end
+
+    private
+
+    def options(opts={})
+      defaults = {
+        basic_auth: { username: '', password: @token },
+        headers: {
+          "User-Agent" => "Reflect Ruby API client v#{Reflect::VERSION}",
+          "Content-Type" => "application/json"
+        }
+      }
+
+      opts.merge(defaults)
+    end
+
+    def dump(obj)
+      JSON.dump(obj)
+    end
+
+    def logger
+      Reflect.logger
+    end
+  end
+end

data/lib/reflect/field.rb

@@ -0,0 +1,19 @@
+module Reflect
+  class Field
+    attr_accessor :name
+    attr_accessor :column_type
+    attr_accessor :type
+    attr_accessor :description
+    attr_accessor :fields
+    attr_accessor :created_at
+    attr_accessor :updated_at
+
+    def initialize(client, attrs={})
+      @client = client
+
+      attrs.each do |k, v|
+        self.send("#{k}=".to_s, v)
+      end
+    end
+  end
+end

data/lib/reflect/key_list.rb

@@ -0,0 +1,21 @@
+module Reflect
+  class KeyList
+    include Enumerable
+
+    attr_reader :keys
+    attr_reader :next
+
+    def initialize(keys, continuation)
+      @keys = keys || []
+      @next = continuation
+    end
+
+    def each(&blk)
+      keys.each(&blk)
+    end
+
+    def empty?
+      keys.count < 1
+    end
+  end
+end

data/lib/reflect/keyspace.rb

@@ -0,0 +1,144 @@
+require 'time'
+require 'reflect/field'
+
+module Reflect
+  class Keyspace
+    attr_reader :client
+
+    attr_accessor :name
+    attr_accessor :slug
+    attr_accessor :statistics_key
+    attr_accessor :description
+    attr_accessor :fields
+    attr_accessor :status
+    attr_accessor :created_at
+    attr_accessor :updated_at
+
+    def initialize(client, attrs={})
+      @client = client
+
+      # If we have fields, we'll need to populate them individually.
+      fields = attrs.delete("fields")
+
+      attrs['updated_at'] = Time.parse(attrs['updated_at']) if attrs['updated_at']
+      attrs['created_at'] = Time.parse(attrs['created_at']) if attrs['created_at']
+
+      attrs.each do |k, v|
+        self.send("#{k}=".to_s, v)
+      end
+
+      if fields
+        self.fields = fields.map { |f| Field.new(f) }
+      end
+    end
+
+    def keys(continuation=nil)
+      resp = client.get(keys_path(slug, continuation))
+
+      if resp.response.code != "200"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+
+      json = JSON.parse(resp.body)
+
+      if json["keys"].nil? || json["keys"].empty?
+        nil
+      else
+        KeyList.new(json["keys"], json["next"])
+      end
+    end
+
+    # Appends records to a tablet. If the tablet doesn't exist it will be
+    # created. records can be either a single object or an array of objects. A
+    # single object represents a single row.
+    #
+    # @param String key the key to create
+    # @param Array|Hash records the records to create
+    #
+    def append(key, records)
+      resp = client.put(path(slug, key), records)
+
+      if resp.response.code != "202"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+    end
+
+    # Replaces the existing records in a tablet with a net set of records.
+    # records can be either a single object or an array of objects. A single
+    # object represents a single row.
+    # 
+    # @param String key the key to create
+    # @param Array|Hash records the records to create
+    #
+    def replace(key, records)
+      resp = client.post(path(slug, key), records)
+
+      if resp.response.code != "202"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+    end
+
+    # Patches the existing records in a tablet with a net set of records. The
+    # criteria parameter indicates which records to match existing records on.
+    # In the Reflect API, if no existing records match the supplied records
+    # then those records are dropped.
+    #
+    # @param String key the key to create
+    # @param Array|Hash records the records to create
+    # @param Array criteria an array of field names within a record to match
+    #
+    def patch(key, records, criteria)
+      resp = client.patch(path(slug, key), records, "X-Criteria" => criteria.join(", "))
+
+      if resp.response.code != "202"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+    end
+
+    # Patch the existing records in a tablet with a new set of records and
+    # insert any that aren't matched. The criteria parameter indicates which
+    # records to match existing records on.
+    #
+    # @param String key the key to create
+    # @param Array|Hash records the records to create
+    # @param Array criteria an array of field names within a record to match
+    #
+    def upsert(key, records, criteria)
+      headers = {
+        "X-Criteria" => criteria.join(", "),
+        "X-Insert-Missing" => true
+      }
+
+      resp = client.patch(path(slug, key), records, headers)
+
+      if resp.response.code != "202"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+    end
+
+
+    # Deletes a key within a keyspace.
+    #
+    # @param String key the key to delete
+    #
+    def delete(key)
+      resp = client.delete(path(slug, key))
+
+      if resp.response.code != "202"
+        raise Reflect::RequestError, Reflect._format_error_message(resp)
+      end
+    end
+
+    private 
+
+    def path(slug, key)
+      "/v1/keyspaces/#{slug}/tablets/#{key}"
+    end
+
+    def keys_path(slug, continuation=nil)
+      base = "/v1/keyspaces/#{slug}/keys"
+      base += "?next=#{continuation}" if continuation
+      base
+    end
+  end
+end

data/lib/reflect/request_error.rb

@@ -0,0 +1,4 @@
+module Reflect
+  class RequestError < StandardError
+  end
+end

data/lib/reflect/version.rb

@@ -0,0 +1,3 @@
+module Reflect
+  VERSION = "0.1.4"
+end

data/reflect.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "reflect/version"
+
+Gem::Specification.new do |s|
+  FILES = Dir[File.expand_path('../lib/**/*.rb', __FILE__)].map { |fi| fi.gsub(File.expand_path('../', __FILE__) +"/", "") } + ['reflect.gemspec']
+
+  s.name = "reflect"
+  s.version = Reflect::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Heller"]
+  s.date = "2015-08-30"
+  s.description = "Ruby client for Reflect.io"
+  s.email = "brad@reflect.io"
+  s.files = FILES
+  s.homepage = "http://github.com/reflect/reflect-rb"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Reflect.io API Ruby client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency('rake', '~> 10.1.0')
+      s.add_development_dependency('minitest', '~> 5.3')
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency('rake', '~> 10.1.0')
+      s.add_development_dependency('minitest', '~> 5.3')
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_development_dependency('rake', '~> 10.1.0')
+    s.add_development_dependency('minitest', '~> 5.3')
+  end
+end
+
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: reflect
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Brad Heller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-30 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+description: Ruby client for Reflect.io
+email: brad@reflect.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/reflect.rb
+- lib/reflect/client.rb
+- lib/reflect/field.rb
+- lib/reflect/key_list.rb
+- lib/reflect/keyspace.rb
+- lib/reflect/request_error.rb
+- lib/reflect/version.rb
+- reflect.gemspec
+homepage: http://github.com/reflect/reflect-rb
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 3
+summary: Reflect.io API Ruby client
+test_files: []