algorithmia 0.2.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e320f18a0a2c63b461e158fe6667eefb3cdb28d
-  data.tar.gz: 21b544a00dce997e0537d0a76b8fc77a4517699d
+  metadata.gz: 15bebf58e21513e4d156ac2cf371be83a716751e
+  data.tar.gz: 2318772a07f846302e7552081d8cd410e1c298c6
 SHA512:
-  metadata.gz: 9405aabdc8d2ca3b7d26facb3aa792307790ec19dbf77123cdcc3d0fc3dce172f3ca033605e460d951d5d7efa4d514d7e544df25a27dfabea5bb66fd54fa62b5
-  data.tar.gz: 6ddbca4ad8bb320253afe4eaf0c367a9291871e130495d140ab76c137ecc5888cc80392f7be00827f0ef438dc599b4e4290dfee9aeccf2997d64b8e7b8662dd2
+  metadata.gz: 46a702c1c1c063e808978b7746f033ce6de312fa3af45bd27b86a2cabf4cfbf73555e724110fe2939d29b6a57a8a7a2a437bb9bc3b470793418a581917b34810
+  data.tar.gz: 324a9e6ae7c64e6ac749d28e7958903448ce885f6920d054a6970fa44640eb122cbf3d8ff532c1cb58b3143fa6fc21f57377d4d97e644b2fe07c8fea0fd6f26a

data/.gitignore

@@ -1 +1,12 @@
-Gemfile.lock
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at support@algorithmia.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "httparty", "~> 0.13.1"
-gem "ripl", "~> 0.7"
+# Specify your gem's dependencies in algorithmia.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Algorithmia
+
+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,196 @@
+# The Algorithmia Ruby Client
+
+The Algorithmia Ruby client is a wrapper for making calls to the Algorithmia API and Data API.
+
+With Algorithmia, you can leverage algorithms written in any language by including them in your Ruby project with a simple API call! Browse the collection of algorithms available on [Algorithmia.com](http://algorithmia.com).
+
+## Installation
+
+#### Local Builds:
+
+Because this gem is yet to be released on ruby gems, follow these instructions to build and use it locally:
+
+```bash
+gem build algorithmia.gemspec && gem install algorithmia-0.1.0.gem
+```
+
+#### Regular installation:
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'algorithmia'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install algorithmia
+```
+
+## Basic Usage
+
+To call to the API, the gem uses a client model. Create and configure a client object with your API key to start making requests.
+
+```ruby
+require algorithmia
+
+# Create a new client instance & set your API key
+client = Algorithmia.client('YOUR_API_KEY')
+
+algorithm        = 'demo/Hello/0.1.1'
+algorithm_result = client.algo(algorithm).pipe("HAL 9000").result
+puts algorithm_result
+# => Hello HAL 9000
+```
+
+### Algorithm Objects
+
+When you call `.algo` on your client, it will return a new instance of `Algorithmia::Algorithm`. On this object, you have the the following methods:
+- `pipe`: the default method to calling an algorithm (recommended)
+- `pipeJson`
+- `set_options`: set query parameters on your request
+
+```ruby
+algorithm = client.algo('demo/Hello/0.1.1')
+# => #<Algorithmia::Algorithm:0x007f80ea092fc8 @client=Algorithmia::Client, @endpoint="demo/Hello/0.1.1", @query_options={:timeout=>300, :stdout=>false, :output=>"default"}>
+
+# Pass in a hash of options to override the default query parameters
+algorithm.set_options({'timeout': 500})
+# => {:timeout=>500, :stdout=>false, :output=>"default"}
+
+# Use these helper methods to enable stdout or change the timeout value
+algorithm.set_timeout(500)
+# => 500
+algorithm.enable_stdout
+# => true
+algorithm
+# => #<Algorithmia::Algorithm:0x007fa008b02de0 @client=Algorithmia::Client, @endpoint="demo/hello", @query_options={:timeout=>500, :stdout=>true, :output=>"default"}>
+
+# Pass the input to the algorithm
+result = algorithm.pipe('HAL 9000')
+# => Hello HAL 9000
+```
+
+### Algorithm Responses
+
+When a successful response from the algorithm is returned, a new Algorithmia::Response object is created.
+
+``` ruby
+# Call an algorithm
+algorithm_response = client.algo(algorithm).pipe("HAL 9000").result
+puts algorithm_response
+# => #<Algorithmia::Response:0x007f9fc2845850 @json={:result=>0.14970585904042558, :metadata=>{:content_type=>"json", :duration=>0.0006857780000000001}}>
+
+# Get the raw json returned from the API
+puts algorithm_response.json
+# => {:result=>0.14970585904042558, :metadata=>{:content_type=>"json", :duration=>0.0006857780000000001}}
+
+# Use any one of the following helper methods to understand the response
+puts algorithm_response.result
+# => 0.14970585904042558
+puts algorithm_response.metadata
+# => {:content_type=>"json", :duration=>0.0006857780000000001}
+puts algorithm_response.duration
+# => 0.0006857780000000001
+puts algorithm_response.content_type
+# => "json"
+puts algorithm_response.stdout
+# => nil
+puts algorithm_response.alerts
+# => nil
+```
+
+### The Data API
+
+The client also allows you to work with the Algorithmia Data API. You can manage your files and directories using DataObjects. There are two types of DataObjects: `DataFile` and `DataDirectory`.
+
+#### DataFiles
+
+```ruby
+file = client.file('data://test_user/test/sample_file.txt')
+ => #<Algorithmia::DataFile:0x007ffbaa8747d8 @client=#<Algorithmia::Client:0x007ffbab0fc798 @api_key="YOUR_API_KEY">, @data_uri="data://test_user/test/sample_file.txt", @url="/data/test_user/test/sample_file.txt">
+
+file.put_file('/path/to/local/file/sample_file.txt')
+# => true
+
+file.exists?
+# => true
+
+# Write a string to the file. This will overwrite any existing content!
+file.put("This is the contents of the file.")
+# => true
+
+# Get the file and write to a local file
+file.get_file
+# => #<File:/var/folders/yl/vv6ws5196cvb61xzwrg8l3vm0000gp/T/test.txt20160328-94761-i8cqxg>
+
+file.get
+# => "This is the contents of the file."
+
+file.delete
+# => true
+```
+
+#### DataDirectories
+
+```ruby
+# Create a DataDirectory object
+dir = client.dir('data://test_user/test')
+# => #<Algorithmia::DataDirectory:0x007ffbab0fc748 @client=#<Algorithmia::Client:0x007ffbab0fc798 @api_key="YOUR_API_KEY">, @data_uri="data://test_user/test", @url="/data/test_user/test">
+
+# Create a new directory
+dir.create
+# => true
+
+dir.exists?
+# => true
+
+# Get a new DataDirectory object for the parent directory
+dir.parent
+# => #<Algorithmia::DataDirectory:0x007ffba924e148 @client=#<Algorithmia::Client:0x007ffbab0fc798 @api_key="YOUR_API_KEY">, @data_uri="data://test_user", @url="/data/test_user">
+
+# Delete the directory
+dir.delete
+# => true
+```
+
+##### Working with directories:
+
+You can iterate over all contents in a directory, only the sub-directories, or the files within the directory by using of the the `each` methods provided. If no block is given to the method, an enumerator will be returned:
+
+```ruby
+# Return an enumerator for all directory contents, each sub-directory, or each file in the directory
+dir.each
+dir.each_directory
+dir.each_file
+#  => #<Enumerator: #<Algorithmia::DataDirectory:0x007ffba89bbcd8 @client=#<Algorithmia::Client:0x007ffbab0fc798 @api_key="YOUR_API_KEY">, @data_uri="data://test_user/test_two", @url="/data/test_user/test_two">:each>
+
+# Iterate all directory contents, each sub-directory, or each file in the directory
+dir.each { |item| block }
+dir.each_directory { |dir| block }
+dir.each_file { |file| block }
+```
+
+
+## Stuck? Need help?
+
+Check out our guides, tutorials, and how-tos in the [Algorithmia Developer Center](http://developers.algorithmia.com) as well as finding more specifics in our [API documentation](http://docs.algorithmia.com).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/algorithmiaio/algorithmia-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Not Yet Implemented:
+- Tests! :scream:
+

data/Rakefile

@@ -1,65 +1,8 @@
-# Algorithmia Ruby wrapper.
-# Released under the MIT License
-# http://github.com/bih/algorithmia
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-# Old dependency stuff.
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec)
 
-$:.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
+task :default => :spec

data/algorithmia.gemspec

@@ -1,30 +1,28 @@
-# -*- 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"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'algorithmia/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'algorithmia'
+  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.authors       = ["Algorithmia"]
+  spec.email         = ["developer@algorithmia.com"]
+  spec.licenses      = ["MIT"]
+  spec.summary       = %q{A Ruby client for making API calls to Algorithmia}
+  spec.description   = %q{This gem provides a friendly client interface to the Algorithmia API, allowing you to call any of the algorithms on the Algorithmia Marketplace.}
+  spec.homepage      = "https://algorithmia.com/"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  
-  spec.add_dependency "rake", "~> 10.4"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+
   spec.add_dependency "json", "~> 1.8"
-  spec.add_dependency "httparty", "~> 0.13.1"
+  spec.add_dependency "httparty", "~> 0.13"
 
-  spec.add_development_dependency "ripl", "~> 0.7"
-end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "algorithmia"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start