spadeio 0.0.1 → 0.0.2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 jondot
+Copyright (c) 2013 Dotan Nahum
 
 MIT License
 

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jondot
+
+MIT License
+
+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

@@ -1,6 +1,8 @@
 # Spadeio
 
-TODO: Write a gem description
+This is the Ruby driver for [Spade](http://spade.io)
+
+See more at the docs: [docs.spade.io](http://docs.spade.io)
 
 ## Installation
 
@@ -18,7 +20,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Here's how to quickly scrape a url with the Ruby client:
+
+
+```ruby
+require 'spadeio'
+
+client = SpadeIO::Client.new :key => '<your-key>'
+res = client.scrape "http://a.url.example.com/some/article.html"
+```
+
 
 ## Contributing
 
@@ -27,3 +38,11 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+
+
+## Copyright
+
+Copyright (c) 2013 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See MIT-LICENSE for further details.
+

data/lib/spadeio/api.rb

@@ -1,4 +1,30 @@
 module SpadeIO::API
   V1 = 'http://api.spade.io/v1/'
   STABLE = V1 
+  FIND_OUT_MORE = {
+    :key => ['http://spade.io'],
+    400 => ['http://docs.spade.io/#errors'],
+    500 => ['http://status.spade.io'],
+    300 => ['http://status.spade.io']
+  }
+
+
+  WHAT_HAPPENED = {
+    :key => "An API key was not supplied when initializing a Spade Client",
+    400 => 'Unauthorized, forbidden or unacceptable request.',
+    500 => 'Server error.',
+    300 => 'Network or downtime error.'
+  }
+
+  FIX_WITH = {
+    :key => ["Please make sure to initialize a client\n     Client.new :key => '<your-key>'\n  Before using it."],
+    400 => ['Verify that your passing a key to Client.',
+            'If you don\'t have a key, sign up at http://spade.io.',
+            'Make sure your key is valid, try support@spade.io for help.'],
+    500 => ['Email support@spade.io with the exact error snippet you\'ve got.',
+            'Check out http://status.spade.io for known downtime.'],
+    300 => ['Try making sure you don\'t have a proxy between you and api.spade.io.',
+            'Make sure you can access http://api.spade.io/ping from a browser.']
+  }
+
 end

data/lib/spadeio/client.rb

@@ -7,7 +7,7 @@ class SpadeIO::Client
 
   def initialize(opts)
     if !opts[:key]
-      raise "Please supply an authentication key in ':key'. Get yours at http://spade.io."
+      raise build_helpful_error(:key)
     end
 
     @opts = opts
@@ -20,31 +20,59 @@ class SpadeIO::Client
 
   def scrape(uri, bucket=nil)
     res = scrape_all(uri, bucket)
-    body = res.body
-    if body && body.count > 0 && body.first['objects']
-      return body.first['objects']
-    else
-      return nil
+    body = res ? res.body : nil
+
+    unless bucket
+      if body && body.count > 0 && body.first['objects']
+        body = body.first['objects']
+      else
+        body = nil
+      end
     end
+
+    body
   end
 
   def scrape_all(uri, bucket)
     res = @conn.get("scrape", { :url => uri })
 
 
-    # XXX seriously work on this error handling area.
-    # dev should get a clear explanation of:
-    #
-    # * what was wrong
-    # * what we think may be wrong, and how to fix it
-    # * where to get more information
-    #
     if res.status != 200
-      raise "error"
+      code_class = res.status - (res.status % 100)
+      raise build_helpful_error(code_class, (res.body || "").to_s[0..50])
     end
 
     res
   end
 
+
+private
+  def build_helpful_error(key, snipt="")
+    res = <<EOF
+Error: #{ SpadeIO::API::WHAT_HAPPENED[key]}
+------
+#{ 
+if snipt != ""
+  "\n<<------  response ------>>\n" + snipt + \
+
+  "\n<<----------------------->>\n"
+end
+}
+
+Try one of these fix it:
+------------------------
+
+#{ bullets( SpadeIO::API::FIX_WITH[key]) }
+
+Find out more here:
+-------------------
+#{ bullets( SpadeIO::API::FIND_OUT_MORE[key]) }
+
+EOF
+  end
+
+  def bullets(arr)
+    arr.map{|s| "* #{s}"}.join("\n")
+  end
 end
 

data/lib/spadeio/version.rb

@@ -1,3 +1,3 @@
 module SpadeIO
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/preview_bucket.json

@@ -0,0 +1,6 @@
+{
+ "title": "title",
+ "thumb": "thumb",
+ "description": "desc",
+ "src": "src"
+}

data/spec/spade_io/client_spec.rb

@@ -13,6 +13,19 @@ describe SpadeIO::Client do
       end.must_raise RuntimeError
     end
 
+    it "should fail nicely for 300, 400, 500 class errors" do
+      uri = "http://foo.example.com/article.html"
+      stub_request(:get,"#{API_ENDPOINT}scrape?url=#{CGI.escape uri}")
+                  .to_return( :status => 401, :body =>  file_fixture('empty.json'))
+
+      c = SpadeIO::Client.new(OPTS)
+      begin
+        res = c.scrape(uri)
+      rescue RuntimeError => err
+        assert_equal true, !!err.message.match(/.*Unauthorized, forbidden or unacceptable.*/m)
+      end
+    end
+    
     it "should send an authenticated scrape to a page" do
       uri = "http://foo.example.com/article.html"
       stub_request(:get,"#{API_ENDPOINT}scrape?url=#{CGI.escape uri}")
@@ -71,5 +84,18 @@ describe SpadeIO::Client do
         res = c.scrape(uri)
       end.must_raise RuntimeError
     end
+
+    it "should return sucessfully when given a preview bucket" do
+      uri = "http://foo.example.com/article.html"
+      stub_request(:get,"#{API_ENDPOINT}scrape?url=#{CGI.escape uri}")
+                  .to_return( :status => 200, :body =>  file_fixture('preview_bucket.json'))
+
+      c = SpadeIO::Client.new(OPTS)
+      res = c.scrape(uri, 'preview')
+
+      expected = JSON.parse(file_fixture('preview_bucket.json'))
+      assert_equal res, expected
+    end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spadeio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -150,6 +150,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/spadeio.rb
@@ -160,6 +161,7 @@ files:
 - spec/fixtures/bigres.json
 - spec/fixtures/empty.json
 - spec/fixtures/no_objects.json
+- spec/fixtures/preview_bucket.json
 - spec/spade_io/client_spec.rb
 - spec/spec_helper.rb
 homepage: http://spade.io
@@ -191,5 +193,6 @@ test_files:
 - spec/fixtures/bigres.json
 - spec/fixtures/empty.json
 - spec/fixtures/no_objects.json
+- spec/fixtures/preview_bucket.json
 - spec/spade_io/client_spec.rb
 - spec/spec_helper.rb