biffbot 1.2.3 → 1.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzkzZWQzN2MyODFkMmNiZjU4MTU5NWM5ZTk3ZTI4MWM2ODBkMDU5OA==
+    YmIwNzhmMTgwNWI3YTExMDE4OGJjMDExN2M1NDFlMjU0MGJhYTI4NQ==
   data.tar.gz: !binary |-
-    Yzg4ZTdhMjI0MzM2NmMxMTVhMjA2MTIxOTUzZTMwYTdkOWRmZTQ0NA==
+    Zjg4NjU1NmI3OTI1ZTRkZWQwOWNlOTVkZGZiYjQxZDgyNzMyNzVlNg==
 SHA512:
   metadata.gz: !binary |-
-    ZDNmMWQxZWY5YmJhMmQ0YzRiMjZlMTNkMDY1Yjg1OTJkNmYwYzQ4Yzc1MGJl
-    NzYwYjc4MzU4NWFmNjNhOWQ4MDIzNjliZjJkZTJmM2U2Y2Y5ZDI0OThiYTkw
-    MTA2ZjIxNTAxYjcwYzg2Yzc2ZWM4NWQ0ZjQ2ZWFmM2FlYWVhYzE=
+    ZGI0ZTMzNjRlY2QxOGZmZDFjNjlkMzhhNmQwNDVhY2M2ZjQ2YjIxMGI0OTg5
+    N2ZlNWExNDMyNzQ0MjZmZDFhNDdhZjNmNzVhOWU0NTkzZDc3Njk4YTVjMzRk
+    OWU1MzA3MjNhNDdhOGU4NTBkZmQ5YjVlM2M2MjgyZTY1M2ZkMGI=
   data.tar.gz: !binary |-
-    Nzg5ZjY0MDFmYmMyYzlhNjhlY2FjM2U0ZmQ2NWFjNTNlZjg1ODczNjEzOTkw
-    MGVkMzE5ODNkYzM4MTFhM2Q3OTNhNGY1YzMzMDI5MGQxYzFmNjU5MzY1YTJl
-    YmE2YTk4ODIxNjg2YjNhYWMzODg4YzBmMjc0MWZkZGYyYTU0NzU=
+    OGIwY2QwNjAzMGJjNDdhNzcwNzNhZGYwZjBjZGJiMzczMjk1NDg4OTM3OTM0
+    YzNlY2RhMzc2MjJiOWI0YTllMjYzMDM0OWIyMDlkMjlmYjRiMzE1YjBiMWQ0
+    MmE4YTZlODdhZGQ0NDBjM2VjODZiNzkyMzE4NzljZjlkNGU2ZWI=

data/README.md

@@ -1,5 +1,4 @@
-# Biffbot
-[![Build Status](https://travis-ci.org/tevren/biffbot.svg?branch=master)](https://travis-ci.org/tevren/biffbot) [![Gem Version](https://badge.fury.io/rb/biffbot.svg)](http://badge.fury.io/rb/biffbot) [![Code Climate](https://codeclimate.com/github/tevren/biffbot/badges/gpa.svg)](https://codeclimate.com/github/tevren/biffbot)
+# Biffbot [![Build Status](https://travis-ci.org/tevren/biffbot.svg?branch=master)](https://travis-ci.org/tevren/biffbot) [![Gem Version](https://badge.fury.io/rb/biffbot.svg)](http://badge.fury.io/rb/biffbot) [![Code Climate](https://codeclimate.com/github/tevren/biffbot/badges/gpa.svg)](https://codeclimate.com/github/tevren/biffbot) [![Test Coverage](https://codeclimate.com/github/tevren/biffbot/badges/coverage.svg)](https://codeclimate.com/github/tevren/biffbot)
 
 Ruby gem to connect to diffbot's APIs
 
@@ -19,23 +18,14 @@ Or install it yourself as:
 
 ## Usage
 
-Usage example:
-OLD DEPCRECATED METHOD: 
+### Usage example:
 
     require 'biffbot'
-    token = YOUR_DEVELOPER_TOKEN
-	biff = Biffbot::Base.new(token)
-	article = biff.parse("the url you want to parse",options)
+    Biffbot.token = YOUR_DEVELOPER_TOKEN
+    analyze = Biffbot::Analyze.new(url, {:type => 'article'})
+    article = Biffbot::Article.new(url,some_hash_of_options)
 
-NEW METHOD: 
-
-    require 'biffbot'
-    token = YOUR_DEVELOPER_TOKEN
-    analyze = Biffbot::Analyze.new(token, url, {:type => 'article'})
-    article = Biffbot::Article.new(@token,url,some_hash_of_options)
-
-
-The available classes are: 
+#### Available classes: 
 * Biffbot::Analyze
 * Biffbot::Article
 * Biffbot::Image

data/biffbot.gemspec

@@ -16,11 +16,13 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(/^bin\//) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
-  gem.add_dependency('httparty')
+  gem.add_dependency('httparty', '~> 0.13')
   gem.add_dependency('json', '~> 1.8')
   gem.add_dependency('hashie', '~> 3.3')
   gem.add_development_dependency('rspec')
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rubocop')
   gem.add_development_dependency('dotenv')
+  gem.add_development_dependency('yard')
+  gem.add_development_dependency('codeclimate-test-reporter')
 end

data/lib/biffbot.rb

@@ -8,9 +8,15 @@ require 'biffbot/image'
 require 'biffbot/product'
 
 module Biffbot
+  def self.configure
+    yield self
+    self
+  end
+
   def self.reset!
     @token = nil
   end
   class << self
+    attr_accessor :token
   end
 end

data/lib/biffbot/analyze.rb

@@ -1,9 +1,16 @@
 require 'biffbot/base'
 module Biffbot
   class Analyze < Base
-    def initialize token, url, options = {}
-      @token = token
-      parse(@token, 'analyze', url, options)
+    # a new instance of Biffbot::Analyze
+    #
+    # @param url [String] The url to analyze
+    # @param options [Hash] An hash of options
+    # @param token [String] Override Biffbot.token with another token
+    # @return [Hash]
+    # @example
+    #   Biffbot::Analyze('http://www.nytimes.com', mode: 'article', timeout: 60) => {SOME_HASH}
+    def initialize url, options = {}, token = Biffbot.token
+      parse(token, 'analyze', url, options)
     end
   end
 end

data/lib/biffbot/article.rb

@@ -1,9 +1,16 @@
 require 'biffbot/base'
 module Biffbot
   class Article < Base
-    def initialize token, url, options = {}
-      @token = token
-      parse(@token, 'article', url, options)
+    # a new instance of Biffbot::Article
+    #
+    # @param url [String] The url of an article to grab
+    # @param options [Hash] An hash of options
+    # @param token [String] Override Biffbot.token with another token
+    # @return [Hash]
+    # @example
+    #   Biffbot::Article('http://www.nytimes.com', timeout: 60) => {SOME_HASH}
+    def initialize url, options = {}, token = Biffbot.token
+      parse(token, 'article', url, options)
     end
   end
 end

data/lib/biffbot/base.rb

@@ -5,13 +5,26 @@ require 'cgi'
 module Biffbot
   class Base < Hash
     include Hashie::Extensions::Coercion
-    def parse token = '', type = 'article', url = '', options = {}
+    # a new instance of Biffbot::Base
+    #
+    # @param token [String]  Override Biffbot.token with another token
+    # @param type [String] pass the class type you're working with
+    # @param url [String] The url of the page you're working with
+    # @param options [Hash] An hash of options
+    # @return [Hash]
+    def parse token = Biffbot.token, type = 'article', url = '', options = {}
       url = parse_options(options, generate_url(CGI.escape(url), token, type, options[:version]))
       JSON.parse(HTTParty.get(url).body).each_pair do |key, value|
         self[key] = value
       end
     end
 
+    # generate an url consisting of your api key and the endpoint you'd like to use
+    #
+    # @param url [String] The url to pass to diffbot
+    # @param token [String] Diffbot API token
+    # @param type [String] API to use
+    # @return [String] a formatted url with your api key, endpoint and input url
     def generate_url url, token, type, version
       case type
       when 'analyze'
@@ -25,6 +38,11 @@ module Biffbot
       url
     end
 
+    # add the options hash to your input url
+    #
+    # @param options [Hash] An hash of options
+    # @param request [String] The url to append options to
+    # @return [String] a formatted url with options merged into the input url
     def parse_options options = {}, request = ''
       options.each do |opt, value|
         case opt

data/lib/biffbot/bulk.rb

@@ -5,10 +5,20 @@ require 'cgi'
 module Biffbot
   class Bulk < Base
     include Hashie::Extensions::Coercion
-    def initialize token
+    # a new instance of Biffbot::Bulk
+    #
+    # @param token [String] Override Biffbot.token with another token
+    def initialize token = Biffbot.token
       @token = token
     end
 
+    # create a bulk job
+    #
+    # @param name [String]  Desired name for bulk job
+    # @param api_type [String] Desired API to use for urls
+    # @param urls [Array] An array of input urls to pass to bulk job
+    # @param options [Hash] An hash of options
+    # @return [Hash]
     def create_job name, api_type, urls = [], options = {}
       api_url = "http://api.diffbot.com/v2/#{api_type}"
       api_url = "http://api.diffbot.com/#{options[:version]}/#{api_type}" if options[:version] == 'v2' || options[:version] == 'v3'
@@ -20,6 +30,13 @@ module Biffbot
       end
     end
 
+    # generate the POST body required for bulk job creation
+    #
+    # @param name [String]  Desired name for bulk job
+    # @param api_url [String] Desired API url to use for urls
+    # @param urls [Array] An array of input urls to pass to bulk job
+    # @param options [Hash] An hash of options
+    # @return [Hash]
     def generate_post_body name, api_url, urls = [], options = {}
       post_body = {token: @token, name: name, apiUrl: api_url, urls: urls}
       options.each do |key, value|
@@ -29,34 +46,28 @@ module Biffbot
       post_body
     end
 
-    def pause name
-      endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&pause=1"
-      JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
-        self[key] = value
-      end
-    end
-
-    def unpause name
-      endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&pause=0"
-      JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
-        self[key] = value
-      end
-    end
-
-    def restart name
-      endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&restart=1"
-      JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
-        self[key] = value
-      end
-    end
-
-    def delete name
-      endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&delete=1"
-      JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
-        self[key] = value
+    # Using define_method to create methods for each action rather than defining each method seperately.
+    %w(pause unpause restart delete view).each do |method_name|
+      define_method method_name do |name|
+        case method_name
+        when 'pause', 'restart', 'delete'
+          endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&#{method_name}=1"
+        when 'unpause'
+          endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}&#{method_name}=0"
+        when 'view'
+          endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}"
+        end
+        JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
+          self[key] = value
+        end
       end
     end
 
+    # retrieve data per given jobName
+    #
+    # @param jobName [String] Name of bulk job
+    # @param _options [Hash] An hash of options
+    # @return [Hash]
     def retrieve_data jobName, _options = {}
       # TODO: add support for csv
       endpoint = "http://api.diffbot.com/v3/bulk/download/#{@token}-#{jobName}_data.json"
@@ -64,12 +75,5 @@ module Biffbot
         self[key] = value
       end
     end
-
-    def view name
-      endpoint = "http://api.diffbot.com/v3/bulk/?token=#{@token}&name=#{name}"
-      JSON.parse(HTTParty.get(endpoint).body).each_pair do |key, value|
-        self[key] = value
-      end
-    end
   end
 end

data/lib/biffbot/custom.rb

@@ -1,10 +1,18 @@
 require 'biffbot/base'
 module Biffbot
   class Custom < Base
-    def initialize token, url, api_name, options = {}
-      @token = token
+    # a new instance of Biffbot::Custom
+    #
+    # @param url [String] The url to pass to your custom api
+    # @param api_name [String] The name of your custom api
+    # @param options [Hash] An hash of options
+    # @param token [String] Override Biffbot.token with another token
+    # @return [Hash]
+    # @example
+    #   Biffbot::Custom('http://www.nytimes.com', 'my_cool_nytimes_api', timeout: 60) => {SOME_HASH}
+    def initialize url, api_name, options = {}, token = Biffbot.token
       options[:api_name] = api_name
-      parse(@token, 'custom', url, options)
+      parse(token, 'custom', url, options)
     end
   end
 end

data/lib/biffbot/image.rb

@@ -1,9 +1,14 @@
 require 'biffbot/base'
 module Biffbot
   class Image < Base
-    def initialize token, url, options = {}
-      @token = token
-      parse(@token, 'image', url, options)
+    # a new instance of Biffbot::Image
+    #
+    # @param url [String] The url of an page with images you want to analyze
+    # @param options [Hash] An hash of options
+    # @param token [String] Override Biffbot.token with another token
+    # @return [Hash]
+    def initialize url, options = {}, token = Biffbot.token
+      parse(token, 'image', url, options)
     end
   end
 end

data/lib/biffbot/product.rb

@@ -1,9 +1,14 @@
 require 'biffbot/base'
 module Biffbot
   class Product < Base
-    def initialize token, url, options = {}
-      @token = token
-      parse(@token, 'product', url, options)
+    # a new instance of Biffbot::Product
+    #
+    # @param url [String] The url of an page with products you want to analyze
+    # @param options [Hash] An hash of options
+    # @param token [String] Override Biffbot.token with another token
+    # @return [Hash]
+    def initialize url, options = {}, token = Biffbot.token
+      parse(token, 'product', url, options)
     end
   end
 end

data/lib/biffbot/version.rb

@@ -1,3 +1,3 @@
 module Biffbot
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/spec/lib/supported/analyze_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 # more tests to come...
 describe Biffbot::Analyze do
   before :each do
-    token = ENV['DIFFBOT_DEV_TOKEN']
     url = 'http://www.huffingtonpost.ca/2012/10/11/amanda-todd-teen-bullying-suicide-youtube_n_1959668.html'
-    @article = Biffbot::Analyze.new(token, url, type: 'article')
+    Biffbot.token = ENV['DIFFBOT_DEV_TOKEN']
+    @article = Biffbot::Analyze.new(url, type: 'article')
   end
 
   describe 'analyze an article' do

data/spec/lib/supported/article_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 # currently tests v2 article api
 describe Biffbot::Article do
   before :each do
-    token = ENV['DIFFBOT_DEV_TOKEN']
     url = 'http://www.huffingtonpost.ca/2012/10/11/amanda-todd-teen-bullying-suicide-youtube_n_1959668.html'
-    @article = Biffbot::Article.new(token, url)
+    Biffbot.token = ENV['DIFFBOT_DEV_TOKEN']
+    @article = Biffbot::Article.new(url)
   end
 
   describe 'Biffbot::Article.parse' do

data/spec/lib/supported/image_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 # currently tests v2 image api
 describe Biffbot::Image do
   before :each do
-    token = ENV['DIFFBOT_DEV_TOKEN']
     url = 'http://www.huffingtonpost.ca/2012/10/11/amanda-todd-teen-bullying-suicide-youtube_n_1959668.html'
-    @image = Biffbot::Image.new(token, url)
+    Biffbot.token = ENV['DIFFBOT_DEV_TOKEN']
+    @image = Biffbot::Image.new(url)
   end
 
   describe 'Biffbot::Image.parse' do

data/spec/lib/supported/product_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 # currently tests v2 product api
 describe Biffbot::Product do
   before :each do
-    token = ENV['DIFFBOT_DEV_TOKEN']
     url = 'http://www.amazon.com/Google-Chromecast-Streaming-Media-Player/dp/B00DR0PDNE/'
-    @product = Biffbot::Product.new(token, url)
+    Biffbot.token = ENV['DIFFBOT_DEV_TOKEN']
+    @product = Biffbot::Product.new(url)
   end
 
   describe 'Biffbot::Product.parse' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biffbot
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Anurag Mohanty
@@ -14,16 +14,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby gem to connect to diffbot's article api
 email:
 - tevren@gmail.com