algorithmia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e447a94758db3ef21b6c33d5bc51a91fd2ea8fa9
+  data.tar.gz: bc2751c57b973ebe204b23581b9faebf370dd496
+SHA512:
+  metadata.gz: fa48bb6e91d94bd0074385bf18ad1d40f90370232e8efc38f3f18bc0e3fbd11fdf8f411707ab95c8aaa0f1123f06d669d39c6f2c5a9630f56250a61b04648159
+  data.tar.gz: aace9f5700afb51664469bd848ca1b03675eece28440b330d5a5b4dc0a0b49bfacc0ffaa84c2cd80753959f20944f107392f4fbb65d66011847bc1a4d6135ede

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,5 @@
+ruby "2.2.0"
+source "https://rubygems.org"
+
+gem "httparty", "~> 0.13.1"
+gem "ripl", "~> 0.7"

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2014 Bilawal Hameed <me@bilaw.al>
+
+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,65 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+# Old dependency stuff.
+
+$:.push File.expand_path("../lib", __FILE__)
+require "rubygems"
+
+def gem_available?(name)
+   Gem::Specification.find_by_name(name)
+rescue Gem::LoadError
+   false
+rescue
+   Gem.available?(name)
+end
+
+def build_gem
+  # Cleanup.
+  sh "sudo gem uninstall algorithmia" if gem_available?("algorithmia")
+  Dir['*.gem'].map{ |f| File.delete(f) } if Dir['*.gem'].any?
+  
+  # Build the new gem.
+  sh "sudo gem build algorithmia.gemspec"
+
+  # Bundle all gems.
+  sh "bundle install"
+
+  # And install it locally!
+  spec = Gem::Specification::load("algorithmia.gemspec")
+  sh "sudo gem install ./algorithmia-#{spec.version}.gem"
+end
+
+def load_console
+  # Load the library.
+  require "algorithmia"
+  require "ripl"
+
+  # Loading the console.
+  puts ("-" * 5) + " Loading Algorithmia Console " + ("-" * 5)
+
+  require "ripl"
+  Ripl.start({ binding: binding })
+end
+
+# Rake stuff.
+
+task :test do
+  $LOAD_PATH.unshift('lib', 'spec')
+  Dir.glob('./spec/**/*_spec.rb') { |f| require f }
+end
+
+task :console do
+  build_gem
+  load_console
+end
+
+task :deploy do
+  build_gem
+
+  spec = Gem::Specification::load("algorithmia.gemspec")
+  sh "gem push algorithmia-#{spec.version}.gem"
+
+  puts ("-" * 5) + " SUCCESS - Gem has been pushed live! " + ("-" * 5)
+end

data/algorithmia.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+$:.push File.expand_path("../lib", __FILE__)
+require "algorithmia/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'algorithmia'
+  spec.version       = Algorithmia::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.license       = 'MIT'
+  spec.summary       = "Ruby library for interacting with Algorithmia.com"
+  spec.description   = "Interact with awesome algorithms created by academics through Algorithmia.com through Ruby."
+  spec.authors       = ["Bilawal Hameed"]
+  spec.email         = 'bilawal@studenthack.com'
+  spec.homepage      = 'http://github.com/bih/algorithmia'
+
+  spec.files         = `git ls-files`.split("\n").select{ |f| f[-4..-1] != ".gem" }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "rake", "~> 10.4"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "httparty", "~> 0.13.1"
+
+  spec.add_development_dependency "ripl", "~> 0.7"
+end

data/lib/algorithmia.rb

@@ -0,0 +1,18 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'algorithmia/base'
+require 'algorithmia/version'
+require 'algorithmia/errors'
+require 'algorithmia/authentication'
+require 'algorithmia/result'
+require 'algorithmia/http'
+
+class Algorithmia
+	def self.call(endpoint, input)
+		post_http("/api/#{endpoint}", input)
+	end
+end

data/lib/algorithmia/authentication.rb

@@ -0,0 +1,24 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+class Algorithmia
+  attr_writer :api_key
+
+  # Authentication stuffs.
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_key?
+    not @api_key.nil?
+  end
+
+  def self.api_key=(api_key)
+    if not api_key.is_a?(String) or api_key.to_s.empty?
+      raise AlgorithmiaApiKeyTooShort.new("Invalid Algorithmia API key")
+    end
+
+    @api_key = api_key
+  end
+end

data/lib/algorithmia/base.rb

@@ -0,0 +1,14 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+require 'singleton'
+require 'httparty'
+
+class Algorithmia
+  include Singleton
+  include HTTParty
+
+  base_uri "https://api.algorithmia.com"
+  format :json
+end

data/lib/algorithmia/errors.rb

@@ -0,0 +1,6 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+class AlgorithmiaException < Exception; end
+class AlgorithmiaApiKeyTooShort < Exception; end

data/lib/algorithmia/http.rb

@@ -0,0 +1,33 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+class Algorithmia
+  private
+
+  def self.post_http(endpoint, params = {})
+    params = params.to_s unless params.is_a?(Hash)
+    parse_output post(endpoint, body: params, headers: { "Authorization" => @api_key, "Accept" => "application/json" })
+  end
+
+  def self.get_http(endpoint, params = {})
+    params = params.to_s unless params.is_a?(Hash)
+    parse_output get(endpoint, query: params, headers: { "Authorization" => @api_key, "Accept" => "application/json" })
+  end
+
+  def self.parse_output(res)
+    result = res.parsed_response
+
+    # Error!
+    raise AlgorithmiaException.new(result[:error]) if result.include?(:error)
+
+    # Result!
+    Algorithmia::Result.new(result)
+  rescue NoMethodError => e
+    raise AlgorithmiaException.new(res.parsed_response)
+  rescue JSON::ParserError => e
+    raise AlgorithmiaException.new(e)
+  rescue Exception => e
+    raise AlgorithmiaException.new(e)
+  end
+end

data/lib/algorithmia/result.rb

@@ -0,0 +1,25 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+class Algorithmia::Result
+  def initialize(hash)
+    @json = clean_output(hash) rescue {}
+  end
+
+  def duration
+    @json[:duration] rescue -1
+  end
+
+  def result
+    @json[:result] rescue nil
+  end
+
+  private
+
+  def clean_output(hash_without_symbols)
+    hash_with_symbols = Hash.new
+    hash_without_symbols.each { |k, v| hash_with_symbols[k.to_sym] = v } if hash_without_symbols.is_a?(Hash)
+    hash_with_symbols
+  end
+end

data/lib/algorithmia/version.rb

@@ -0,0 +1,7 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+class Algorithmia
+  VERSION = "0.1.0"
+end

data/readme.markdown

@@ -0,0 +1,37 @@
+![Algorithmia for Ruby](algorithmia.png)
+
+# Ruby Wrapper for Algorithmia
+
+Looks very interesting, so I quickly threw together an awesome Ruby wrapper to interact with [Algorithmia.com](http://algorithmia.com).
+
+### Installation
+
+```
+# By your command line.
+$ gem install algorithmia
+
+# Alternatively, through your Gemfile.
+gem 'algorithmia'
+```
+
+### Documentation
+Keeping it simple for now. But it's super easy to make a request to Algorithmia:
+
+```ruby
+require "algorithmia"
+
+# Your API key. Get it from your dashboard on Algorithmia.com
+Algorithmia.api_key = "[INSERT API KEY]"
+
+query = Algorithmia.call("kenny/Factor", 29)
+# Example for algorithm: https://algorithmia.com/algorithms/kenny/Factor
+# => #<Algorithmia::Result:0x007fad12c4fc68 @json={:duration=>0.035231213000000004, :result=>[29]}>
+
+query.result # => [29]
+query.duration # => 0.035231213000000004
+```
+
+See full [Algorithmia.com API docs by clicking here](https://algorithmia.com/docs/api#curl).
+
+### Who made this?
+[Bilawal Hameed](http://github.com/bih). Released freely under the [MIT License](http://bih.mit-license.org/).

data/spec/algorithmia_spec.rb

@@ -0,0 +1,17 @@
+# Algorithmia Ruby wrapper.
+# Released under the MIT License
+# http://github.com/bih/algorithmia
+
+# Required according to the command-line tool.
+gem 'minitest'
+
+# Load in the test.
+require 'minitest/autorun'
+require 'minitest/spec'
+
+# And the source of Algorithmia, of course.
+FileList['lib/**/*.rb'].each{ |source| load(source) }
+
+class AlgorithmiaRubyTest < Minitest::Test
+  # TODO: Some tests.
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: algorithmia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bilawal Hameed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: ripl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Interact with awesome algorithms created by academics through Algorithmia.com
+  through Ruby.
+email: bilawal@studenthack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- algorithmia.gemspec
+- algorithmia.png
+- lib/algorithmia.rb
+- lib/algorithmia/authentication.rb
+- lib/algorithmia/base.rb
+- lib/algorithmia/errors.rb
+- lib/algorithmia/http.rb
+- lib/algorithmia/result.rb
+- lib/algorithmia/version.rb
+- readme.markdown
+- spec/algorithmia_spec.rb
+homepage: http://github.com/bih/algorithmia
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby library for interacting with Algorithmia.com
+test_files:
+- spec/algorithmia_spec.rb