algorithmiaio/algorithmia-ruby

Ruby Client for Algorithmia Algorithms and Data API

algorithmia-ruby's Issues

Change HTTP classname to something...better?

The class name Http is not great. Maybe "Requests" or "requestor"?

Rubyify `options` and `timeout` methods

The way to set these was based on spec, but should be refactored to be more Ruby intuitive.

Algorithm errors are not getting surfaced to the user

Instead of an algorithm response (in the event of an exception) getting returned to the user as a named exception with a stacktrace (like with out other clients) the ruby client instead returns "Oops, something went wrong" instead.

algorithmia-ruby/lib/algorithmia/requester.rb

Line 96 in 1795ba6

when 500..599

This was experienced by one of our customers and has slowed down their development, we should look to investigate this further.

Move Auth file contents to Client

Not really worth the separate file here now that client has been refactored to be small.

Need to be able to change base_uri

2 related points:

1. base URI shouldn't include /v1 but rather default to https://api.algorithmia.com. This is consistent with other clients and is especially helpful in the 2nd point:
2. We need to expose base_uri, so that it can be modified for pointing the client at test, local, enterprise, or other environments using the same client.

put_file should accept a file or a path

https://github.com/algorithmiaio/algorithmia-ruby/blob/master/lib/algorithmia/data_file.rb#L34

json gem version

Hi. Are having some problems with the JSON gem and algorithmia, version 2.01 (and all others). In Ruby json-gem 2.04 is default, but the requirement here is json 1.8.6. There seems to be a conflict of some sort however:

usr/local/rvm/rubies/ruby-2.4.0/lib/ruby/site_ruby/2.4.0/rubygems/specification.rb:2302:in `raise_if_conflicts': Unable to activate algorithmia-1.0.1, because json-2.0.2 conflicts with json (~> 1.8) (Gem::ConflictError)

Is it necessary to require 1.8, or could it be jumped to at least 2.0.2 so this doesn't happen? Don't know how to solve the problem otherwise, it occurs on an Ubuntu machine 14.04 LTS. I know it's a rather old distro, but its the one C9.io runs on and that's what I'm working on.

Encoding::UndefinedConversionError: "\xFF" from ASCII-8BIT to UTF-8

I tried to get file from algorithmia. I used SmartThumbnail algorithm for creating thumbnails and uploading it to directory. But i got error Encoding::UndefinedConversionError: "\xFF" from ASCII-8BIT to UTF-8

Refactor unathenticated algo & data methods

in algorithmia.rb, Algorithmia::Algorithm.new(Unauth..... can be replaced with UnauthenticatedClient.new.algo(...

Simplify case statement evaluation

In file http.rb, change case statement on line 65 to use case response.code and when XXX.

Method `exists?` shouldn't throw an error.

Exists should not throw the 404 when it occurs, but it should def ...rescue error:not found ...end

Use Addressable to validate URIs

See Addressable.
Also use match methods to validate presence of "data://" on data URIs & "algo://" on algorithm URIs.

pipe_json should explicitly set Content-Type

pipe_json should explicitly set Content-Type to application/json, however in skimming a little deeper, Http.post will try to do .to_json on it if that header is present, and that would escape the string incorrectly. So, I don't think it's quite as simple as just setting Content-Type to fix. Off the top of my head, this may need some sort of change to Http or perhaps just parsing the json_string before calling post (a bit redundant to deserialize and reserialize, but at least it would verify the string was valid JSON)

pipe has a client Read Timeout at 60 second

the underlying HttpParty defaults to a 60 second client timeout for all requests and we never override it, even when setting the timeout query parameter.

`basename` returns a string instead of `Pathname`

This caught me by surprise because I tried comparing a DataFile.basename with a local Pathname.basename and they weren't equal when I expected them to be because DataObject.basename returns a String but the std library's Pathname.basename returns a Pathname

Privatize "sanitize_URI" methods

Method should be private. Algo & DataFile & Data Directory

D.R.Y. for shared DataFile/DataDirectory methods

sanitize_data_uri and parent could both share implementation in DataObject rather than being implemented twice (DataFile and DataDirectory)

File saving in ruby 2.7 is showing "warning: URI.escape is obsolete"

The actual problem seems to be URI.encode, which is an alias for URI.escape. I think this could be changed to just CGI.encode the file name in lines 51 and 70 of lib/algorithmia/data_directory. I'll research further and open a PR as soon as possible, but could use some feedback on this if possible.

Error messages in API response are not surfaced by Requester

Problem Description

When an algorithm developer attempts to invoke another algorithm with an improperly configured client:

client = Algorithmia.client('<api key>')
client.algo('example/algo').pipe(input)

The API returns an appropriately descriptive error message in its response:

{
    "error": {
        "message": "invalid authorization: api keys are not allowed within algorithms"
    }
}

That tells the algorithm developer that API keys are not to be used within algorithms.

However, the algorithmia-ruby library does not surface this message. Instead, it raises an exception with a rather misleading message:

Error: The request you are making requires authorization. Please check that you have permissions & that you've set your API key.
/opt/algorithm/vendor/bundle/ruby/2.2.0/gems/algorithmia-1.0.1/lib/algorithmia/requester.rb:92:in `check_for_errors'
# ...

Cause

Requester#check_for_errors intends to surface the API response error message, as can be seen on line 87:

message = response.dig("error", "message") if response.is_a?(Hash)

However, the response object returned is a HTTParty::Response object. This HTTParty::Response object is returned by the delegated get, post, put, head, and delete within Requester

Note that while the HTTParty::Response responds to Hash-like methods due to internal method_missing delegation, is_a? Hash will evaluate to false.

Additional Concern

Even if we were to remove a Hash type check, we must be careful. Hash#dig was added in Ruby 2.3; and the Algorithmia developer platform runs on Ruby 2.2. Therefore Hash#dig is not available to algorithm developers and will raise an error if invoked within an algorithm.

Solution

There are a few possible solutions. First, we should remove the Hash type check. Additionally, we should either find a way other than Hash#dig to retrieve the error message, or we should specify a required ruby version in the gem specification for this library.

Also, it may make sense to add a regression test to exercise this code path such that it doesn't resurface in the future.

algorithm errors should raise exceptions

I didn't spend enough time characterizing this, but wanted to file it for tracking/followup. It seems like most non-200 responses raise exceptions just fine, but an algorithm that returns an error doesn't seem to raise an exception, and at least at first glance I failed to figure out how to extract the error message (short of just printing the entire response object)