leggy 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00848a2dcf3ee691668ea9c2039f106f2dca6691
-  data.tar.gz: f896cce3d1c91d8434f2cd4332b26bab132d053d
+  metadata.gz: e7f28d231bf567519d180e03632c738d5557e1ce
+  data.tar.gz: edce7a1ef7ee3123b2aede13b5df5622e7a84c47
 SHA512:
-  metadata.gz: 3803a5ca4ade53b29814169306cc621e93ca45fb40a9cd789cff3b103023afcd89c281d97fb0c2fed2936768b1231b6054edf5ef4649078198c13485edfecc11
-  data.tar.gz: a6c0a8bb96aaa79f382e403e55bace16151ae753cf01262a6e07cfa5a392613fbf631b6d81ba5b183bf7a75d7423835e9d81367777f8b67dc42699ebde040eda
+  metadata.gz: cbdf3042c82634faae01a3c4b2cbfc6d6265c44099bbaf96d3f01e8e2d03a991c444080021f22ff41c26bf3bbbda2f002fb5ef16ee59f7194dcf5de42b301563
+  data.tar.gz: 53973b207036638ca4b20463cb30ce7149bc5eca45c61088b44dd21a27316ab4c106d880c4465377d3cd0214807da6175d4b5893e8b36540df22f6f7ff765705

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: 0ea6fd96ce507aad5efbac5eca10ac0e6cc83bcd75ec8305830b450c68c42714

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in leggy.gemspec
 gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end

data/README.md

@@ -1,6 +1,12 @@
 # Leggy
 
-Ruby wrapper for the 80Legs API. Sign up for a new account at <http://80legs.com/> or view the API docs at <http://datafiniti.github.io/80docs/>.
+[![Gem Version](https://img.shields.io/gem/v/leggy.svg?style=flat)](https://rubygems.org/gems/leggy)
+[![Build Status](https://img.shields.io/travis/activefx/leggy.svg?style=flat)](http://travis-ci.org/activefx/leggy)
+[![Code Climate](https://img.shields.io/codeclimate/github/activefx/leggy.svg?style=flat)](https://codeclimate.com/github/activefx/leggy)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/activefx/leggy.svg?style=flat)](https://codeclimate.com/github/activefx/leggy/coverage)
+[![Dependency Status](https://gemnasium.com/activefx/leggy.svg)](https://gemnasium.com/activefx/leggy)
+
+Leggy is a simple Ruby wrapper for the 80Legs API. Sign up for a new account at [http://80legs.com/](http://80legs.com/) or view the API docs at [http://datafiniti.github.io/80docs/](http://datafiniti.github.io/80docs/). Leggy is built on top of [Resource Kit](https://github.com/digitalocean/resource_kit) and [Kartograph](https://github.com/digitalocean/kartograph) and accepts custom [Faraday](https://github.com/lostisland/faraday) connections.
 
 ## Installation
 
@@ -20,7 +26,194 @@ Or install it yourself as:
 
 ## Usage
 
-Please see the spec file for sample usage. 
+Before you can use the 80Legs client, you need to configure the API token. You can use the .configure method to do so: 
+
+````ruby
+Leggy.configure do |config|
+  config.api_token = 'api_token'
+end
+````
+
+Or you can set it as as the `80_LEGS_API_TOKEN` ENV variable: 
+
+````
+$ export 80_LEGS_API_TOKEN=your_80legs_api_token
+````
+
+Sign up for an account and API token at [80legs](http://80legs.com/).
+
+### Users 
+
+See [http://datafiniti.github.io/80docs/?ruby#users](http://datafiniti.github.io/80docs/?ruby#users) for complete documentation.
+
+#### Get User Data
+
+````ruby 
+user = Leggy.users.find(api_token: Leggy.configuration.api_token)
+user.first_name 
+#=> "Matt" 
+````
+
+### Apps
+
+See [http://datafiniti.github.io/80docs/?ruby#apps](http://datafiniti.github.io/80docs/?ruby#apps) for complete documentation.
+
+#### Get All Apps
+
+````ruby 
+apps = apps = Leggy.apps.all
+apps.first.name
+#=> "TextFromURLListOnly.js"
+````
+
+#### Upload an App
+
+````ruby 
+file = File.read("/path/to/my/eighty_app.js")
+Leggy.apps.create(name: 'eighty_app', body: file)
+#=> true 
+````
+
+For more information on creating an 80app, see: [https://80legs.groovehq.com/knowledge_base/categories/80apps](https://80legs.groovehq.com/knowledge_base/categories/80apps).
+
+#### Get a Specific App
+
+````ruby
+app = Leggy.apps.find(name: 'TextFromURLListOnly.js')
+app.name
+#=> "TextFromURLListOnly.js"
+````
+
+#### Delete an App 
+
+*CAUTION* This action cannot be undone. 
+
+````ruby
+Leggy.apps.delete(name: 'sample_delete')
+#=> true
+````
+
+### Url Lists
+
+See [http://datafiniti.github.io/80docs/?ruby#url-lists](http://datafiniti.github.io/80docs/?ruby#url-lists) for complete documentation.
+
+#### Upload Url List
+
+With the list.json file as follows:
+
+````
+[
+  "http://example.com",
+  "https://example.org"
+]
+````
+
+You can now upload the list.json url list to 80legs: 
+
+````ruby 
+file = File.read(/path/to/my/urls/list.json)
+url = Leggy.urls.create(name: 'sample', body: file)
+urls.name
+#=> "sample"
+````
+
+#### Get All Url Lists
+
+````ruby
+urls = Leggy.urls.all
+urls.collect(&:name)
+#=> ["sample"]
+````
+
+#### Get Specific Url List 
+
+Given your list.json file uploaded previously includes http://example.com && http://example.org:
+    
+````ruby
+Leggy.urls.find(name: 'sample')
+#=> ["http://example.com", "https://example.org"]
+````
+
+#### Delete a Url List 
+
+*CAUTION* This action cannot be undone. 
+
+````ruby
+Leggy.urls.delete(name: 'sample')
+#=> true
+````
+
+### Crawls
+
+See [http://datafiniti.github.io/80docs/?ruby#crawls](http://datafiniti.github.io/80docs/?ruby#crawls) for complete documentation.
+
+#### View All Crawls
+
+````ruby
+crawls = Leggy.crawls.all
+crawls.first.status
+#=> "COMPLETED"
+````
+
+Querying by status is not yet available. 
+
+#### Create a Crawl 
+
+````ruby
+options = { 
+  name: 'crawl_test',
+  urllist: 'sample_crawl_list',
+  app: "HeaderData.js",
+  max_depth: 1,
+  max_urls: 10  
+}
+Leggy.crawls.start(options)
+#=> true
+````
+
+#### Get Crawl Status
+
+````ruby
+crawl = Leggy.crawls.status(name: 'crawl_test')
+crawl.status 
+#=> "QUEUED"
+````
+
+#### Cancel a Crawl 
+
+````ruby
+Leggy.crawls.cancel(name: 'crawl_test')
+#=> true
+````
+
+Once cancelled, the crawl cannot be restarted. 
+
+### Results
+
+See [http://datafiniti.github.io/80docs/?ruby#results](http://datafiniti.github.io/80docs/?ruby#results) for complete documentation.
+
+#### View Results for a Crawl
+
+````ruby
+results = Leggy.results.all(name: 'testing_crawl_results')
+results.first
+#=> "http://datafiniti-voltron-results.s3.amazonaws.com/<TOKEN>/167627_1.txt"
+````
+
+### Errors
+
+See [http://datafiniti.github.io/80docs/?ruby#errors](http://datafiniti.github.io/80docs/?ruby#errors) for complete documentation.
+
+Leggy raises the following errors: 
+
+* 400 (Bad Request): `Leggy::Exception::BadRequest`
+* 401 (Unauthorized): `Leggy::Exception::Unauthorized`
+* 404 (Not Found): `Leggy::Exception::NotFound` 
+* 422 (Unprocessable Entity): `Leggy::Exception::UnprocessableEntity`
+* 523 (Service Unavailable): `Leggy::Exception::ServiceUnavailable` 
+* 5xx (Server Error): `Leggy::Exception::ServerError` 
+
+All exceptions inherit from `Leggy::Error`, so you can use that rescue from any exceptions this client library raises. This does not take into account errors external dependencies may raise, such as Faraday or http adapter errors. 
 
 ## Contributing
 

data/Rakefile

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

data/leggy.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "dotenv"
 
-  spec.add_dependency "gem_config", ">= 0.3"
+  spec.add_dependency "gem_config", "~> 0.3"
   spec.add_dependency "faraday", "~> 0.9"
   spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_dependency "resource_kit", "~> 0.1"
-  spec.add_dependency "kartograph", ">= 0.0.8"
+  spec.add_dependency "kartograph", "~> 0.2"
   spec.add_dependency "activesupport", "~> 4.0"
 
 end

data/lib/leggy.rb

@@ -8,6 +8,8 @@ require "active_support/concern"
 require "active_support/core_ext/hash/slice"
 require "ostruct"
 
+require "leggy/exceptions"
+require "leggy/error_handler"
 require "leggy/helpers"
 require "leggy/user"
 require "leggy/app"
@@ -23,12 +25,13 @@ require "leggy/resource/user"
 require "leggy/resource/app"
 require "leggy/resource/url"
 require "leggy/resource/crawl"
+require "leggy/resource/result"
 
 module Leggy
   include GemConfig::Base
 
   with_configuration do
-    has :api_token,     classes: String,  default: ENV['80_LEGS_API_TOKEN']
+    has :api_token, classes: String, default: ENV['80_LEGS_API_TOKEN']
   end
 
   def self.api_token
@@ -40,7 +43,7 @@ module Leggy
   end
 
   def self.connection
-    @connection ||= Faraday.new(
+    Faraday.new(
       url: 'https://api.80legs.com',
       headers: {
         content_type: 'application/json',
@@ -69,14 +72,20 @@ module Leggy
     Leggy::Resource::Url.new(setup(options))
   end
 
-  # This resource allows for the creation and cancelation of crawls. It also allows
-  # the user to view the crawl status and settings. When the crawl is complete the
-  # links of the results will also be provided within the crawl.
+  # This resource allows for the creation and cancelation of crawls.
+  # It also allows the user to view the crawl status and settings.
   #
   def self.crawls(options = {})
     Leggy::Resource::Crawl.new(setup(options))
   end
 
+  # This resource allows for viewing a list of the urls containing
+  # the crawl results.
+  #
+  def self.results(options = {})
+    Leggy::Resource::Result.new(setup(options))
+  end
+
   def self.setup(options)
     options[:connection] = connection unless options[:connection]
     options

data/lib/leggy/app.rb

@@ -2,12 +2,11 @@ module Leggy
   class App
     include Leggy::Helpers
 
-    attr_accessor(
+    attr_accessor \
       :name,
       :user,
       :location,
       :date_created
-    )
 
   end
 end

data/lib/leggy/crawl.rb

@@ -2,7 +2,7 @@ module Leggy
   class Crawl
     include Leggy::Helpers
 
-    attr_accessor(
+    attr_accessor \
       :name,
       :app,
       :user,
@@ -16,7 +16,6 @@ module Leggy
       :maxUrls,
       :status,
       :results
-    )
 
   end
 end

data/lib/leggy/crawl_options.rb

@@ -6,13 +6,12 @@ module Leggy
       attrs.slice(*Leggy::CrawlOptions.attr_accessors).each { |k,v| send("#{k}=",v) }
     end
 
-    attr_accessor(
+    attr_accessor \
       :app,
       :urllist,
       :data,
       :max_depth,
       :max_urls
-    )
 
   end
 end

data/lib/leggy/error.rb

@@ -0,0 +1,4 @@
+module Leggy
+  class Error < StandardError
+  end
+end

data/lib/leggy/error_handler.rb

@@ -0,0 +1,30 @@
+module Leggy
+  module ErrorHandler
+
+    def self.included(base)
+      base.send(:resources) do
+
+        default_handler do |response|
+          case response.status
+          when 200...299
+            next
+          when 400
+            raise Leggy::Exception::BadRequest.new("#{response.status}: #{response.body}")
+          when 401
+            raise Leggy::Exception::Unauthorized.new("#{response.status}: #{response.body}")
+          when 404
+            raise Leggy::Exception::NotFound.new("#{response.status}: #{response.body}")
+          when 422
+            raise Leggy::Exception::UnprocessableEntity.new("#{response.status}: #{response.body}")
+          when 523
+            raise Leggy::Exception::ServiceUnavailable.new("#{response.status}: #{response.body}")
+          else
+            raise Leggy::Exception::ServerError.new("#{response.status}: #{response.body}")
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/lib/leggy/exceptions.rb

@@ -0,0 +1,30 @@
+# 400 Bad Request Often times a missing or incorrect parameter
+# 401 Unauthorized  Invalid/Missing API Token
+# 404 Not Found Using an invalid API end point, or the user supplied path is incorrect
+# 422 Unprocessable Entity  All the parameters were correct but the request was rejected on the back end, contact support with request information
+# 523 Service Unavailable The API is currently unavailable due to maitenance, try again later.
+# 5xx Server Error  There was an error within the Datafiniti servers
+#
+require 'leggy/error'
+
+module Leggy
+  module Exception
+    class BadRequest < Leggy::Error
+    end
+
+    class Unauthorized < Leggy::Error
+    end
+
+    class NotFound < Leggy::Error
+    end
+
+    class UnprocessableEntity < Leggy::Error
+    end
+
+    class ServiceUnavailable < Leggy::Error
+    end
+
+    class ServerError < Leggy::Error
+    end
+  end
+end

data/lib/leggy/mapping/app.rb

@@ -6,13 +6,8 @@ module Leggy
       kartograph do
         mapping Leggy::App
 
-        property *Leggy::App.attr_accessors, scopes: :read
+        property *Leggy::App.attr_accessors, scopes: [ :read ]
       end
     end
   end
 end
-
-# name  string  The name given to the app.
-# user  string  The user the app is associated with.
-# location  string  The internal location for the app.
-# date_created  date  The date the app was uploaded.