datarank 0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 304cf6063603e0cc2f5f5a6f18d869a7e6b64e87
-  data.tar.gz: c15fb91c2288492cb93605775d24aa9518dc0203
+  metadata.gz: c79c39f0bddf6c27bbde8513e3826f62fbb9dbac
+  data.tar.gz: 4423093bb1ccfbe57c08ede5127142aae82fee4d
 SHA512:
-  metadata.gz: 893780eec58cb8bebde06311eebd649fd50ed42151e2fabe17e79f826a950dc2c8d9f1cbb7a90813fb7e9115490e1315286d29d2f4db4c2a851f57d2cd10e427
-  data.tar.gz: 532b7098f0aa936ed66c0e258c54bd37b0ebebcfe2a3a7d3e5540d9a9a211cf049da0c883aba5d92381b185a8c33aa1b3f354fee3b125ad3a788fc0802610b08
+  metadata.gz: 73bce6af67c1ba008efb922463f22eeb7d1f7baa1f30439229a83ed2c09461c62606fbb953889e6bf325deba7b40e6a4c1d339f9ae94409d55cf695112ca624d
+  data.tar.gz: 602a60993a05a92f2fc767f12ce5f1bad8f6da409625c8f0a6dd801594fa0b05e4d9536df0b582818ea9c5a22dd8dc0614dc280a01f5042efa65524c03d81a44

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+env:
+  global:

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-0.1
+0.1-0.2
 ---
-Alpha release of DataRank Ruby Library
+Alpha release of DataRank Ruby Library

data/Gemfile

@@ -7,4 +7,12 @@ group :development do
   gem 'yard'
 end
 
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'vcr', '~> 2.9.0'
+  gem 'webmock', '>= 1.18.0'
+  gem "codeclimate-test-reporter", require: nil
+end
+
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datarank (0.2)
+    datarank (1.0.0)
       hashie (>= 1.2.0)
       httparty (>= 0.8.3)
       multi_json (>= 1.3.4)
@@ -9,11 +9,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.6)
     celluloid (0.16.0)
       timers (~> 4.0.0)
+    codeclimate-test-reporter (0.4.3)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    fakeweb (1.3.0)
     ffi (1.9.6)
     formatador (0.2.5)
     guard (2.10.1)
@@ -58,6 +62,7 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.2)
+    safe_yaml (1.0.4)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
@@ -66,18 +71,24 @@ GEM
     thor (0.18.1)
     timers (4.0.1)
       hitimes
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
     yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   datarank!
-  fakeweb (~> 1.3.0)
   guard-rspec
   guard-yard
   pry
   rake
-  rspec (~> 2.12)
-  simplecov (~> 0.7.1)
+  rspec
+  simplecov
+  vcr (~> 2.9.0)
+  webmock (>= 1.18.0)
   yard

data/README.md

@@ -1,5 +1,10 @@
 # DataRank API Ruby Library
 
+[![Gem Version](https://badge.fury.io/rb/datarank.svg)](http://badge.fury.io/rb/datarank)
+[![Build Status](https://travis-ci.org/datarank/datarank-ruby.svg)](https://travis-ci.org/datarank/datarank-ruby/master)
+[![Code Climate](https://codeclimate.com/github/datarank/datarank-ruby/badges/gpa.svg)](https://codeclimate.com/github/datarank/
+datarank-ruby)
+
 ## Documentation
 
 [http://www.rubydoc.info/github/datarank/datarank-ruby/master](http://www.rubydoc.info/github/datarank/datarank-ruby/master)
@@ -10,26 +15,25 @@
 
 ## Getting Started
 
-Using bundler, datarank will be automatically included for your project through your gemfile. If you would like to interactively play with the API, use `bundle console`.
 
 **Instance method usage:**
 ```ruby
-client = Datarank::Client.new(api_key,api_version)
+client = Datarank::Client.new(api_key, api_version)
 topics = client.all_topics
 ```
 
 ### Authentication
 
 ```ruby
-client = Datarank::Client.new(api_key,api_version)
+client = Datarank::Client.new(api_key, api_version)
 ```
 
 ## More Examples
 
-** Fetch comments for a topic
+**Fetch comments for a topic**
 
 ```ruby
-client = Datarank::Client.new(api_key,api_version)
+client = Datarank::Client.new(api_key, api_version)
 comments = client.comments_search "tide-pods", {limit: 10}
 ```
 

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler'
+
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'

data/datarank.gemspec

@@ -5,22 +5,19 @@ require 'datarank/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "datarank"
-  gem.version       = Datarank::VERSION
+  gem.version       = Datarank::Version.to_s
   gem.authors       = ["Addam Hardy"]
   gem.email         = ["addam@datarank.com"]
-  gem.description   = ["Ruby Wrapper for the DataRank REST API"]
+  gem.description   = "Ruby Wrapper for the DataRank REST API"
   gem.summary       = [""]
-  gem.homepage      = "http://www.datarank.com"
+  gem.homepage      = "https://github.com/datarank/datarank-ruby"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rspec", "~> 2.12"
-  gem.add_development_dependency "fakeweb", "~> 1.3.0"
   gem.add_development_dependency "rake"
-  gem.add_development_dependency 'simplecov', '~> 0.7.1'
 
   gem.add_dependency "httparty", ">= 0.8.3"
   gem.add_dependency "multi_json", ">= 1.3.4"

data/lib/datarank.rb

@@ -16,12 +16,12 @@ module Datarank
       client.respond_to?(method_name, include_private) || super
     end
 
-    private
+    # private
 
-    def method_missing(method_name, *args, &block)
-      return super unless client.respond_to?(method_name)
-      client.send(method_name, *args, &block)
-    end
+    # def method_missing(method_name, *args, &block)
+    #   return super unless client.respond_to?(method_name)
+    #   client.send(method_name, *args, &block)
+    # end
 
   end
 end

data/lib/datarank/client.rb

@@ -4,8 +4,18 @@ require 'hashie'
 require 'time'
 require 'securerandom'
 
-require "datarank/topics"
 require "datarank/comments"
+require "datarank/datasources"
+require "datarank/fizzle"
+require "datarank/live"
+require "datarank/locations"
+require "datarank/reach"
+require "datarank/retailers"
+require "datarank/sentiment"
+require "datarank/themes"
+require "datarank/topics"
+require "datarank/volume"
+require "datarank/wordcloud"
 
 module Datarank
   class Client
@@ -13,6 +23,17 @@ module Datarank
 
     include Datarank::Client::Topics
     include Datarank::Client::Comments
+    include Datarank::Client::Datasources
+    include Datarank::Client::Fizzle
+    include Datarank::Client::Live
+    include Datarank::Client::Locations
+    include Datarank::Client::Reach
+    include Datarank::Client::Retailers
+    include Datarank::Client::Sentiment
+    include Datarank::Client::Themes
+    include Datarank::Client::Volume
+    include Datarank::Client::Wordcloud
+
 
     BASE_URI = 'https://api.datarank.com'
 
@@ -65,6 +86,7 @@ module Datarank
       request_options[:headers] = headers
 
       r = self.class.send(verb, path, request_options)
+      # FIXME: raise errors on actual error packages
       hash = Hashie::Mash.new(JSON.parse(r.body))
       raise Error.new(hash.error) if hash.error
       raise Error.new(hash.errors.join(", ")) if hash.errors

data/lib/datarank/comments.rb

@@ -1,9 +1,19 @@
 module Datarank
   class Client
+
+    # Module containing methods for interacting with comments
     module Comments
+
+      # Query interface for comments correlated to a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      # @option options [1..1000] :limit The number of items to return.
+      # @option options - all query options available in API docs
       def comments_search(slug, options={})
         get "/topics/#{slug}/comments", options
       end
+
     end
+
   end
 end

data/lib/datarank/datasources.rb

@@ -0,0 +1,24 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with datasources
+    module Datasources
+      
+      # Return unique datasources correlated to a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def datasources slug
+        get "/topics/#{slug}/datasources"
+      end
+
+      # Return unique datasources correlated to a topic grouped by type
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def datasources_by_type slug
+        get "/topics/#{slug}/datasources/types"
+      end
+    
+    end
+
+  end
+end

data/lib/datarank/fizzle.rb

@@ -0,0 +1,34 @@
+module Datarank
+  class Client
+
+    module Fizzle
+
+      # Validate a fizzle query's syntax
+      #
+      # @param options [String] :q Fizzle Query
+      # @note Fizzle query requires 'fizzle: ' be prepended to query
+      def fizzle_validate query
+        post "/fizzle/validate", {q: query}
+      end
+
+      # Test a fizzle query against a given set of comments
+      #
+      # @param query [String] :q Fizzle Query
+      # @param query [Array< Hash{ comment: String } >] :comments Array of comments to match against
+      # @note Fizzle query requires 'fizzle: ' be prepended to query
+      def fizzle_match query
+        post "/fizzle/match", query
+      end
+
+      # Filter a 100,000 comment sample with a fizzle query
+      #
+      # @param query [String] :q Fizzle Query
+      # @note Fizzle query requires 'fizzle: ' be prepended to query
+      def fizzle_search query
+        post "/fizzle/search", {q: query}
+      end
+    
+    end
+
+  end
+end

data/lib/datarank/live.rb

@@ -0,0 +1,24 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with live search
+    module Live
+
+      # Query twitter data with a query string and return volume points grouped by day
+      #
+      # @param query [String] Phrase to search twitter
+      def twitter_volume_daily query
+        get "/search/twitter/volume/daily", {query: query}
+      end
+
+      # Query twitter data with a query string and return tweets
+      #
+      # @param query [String] Phrase to search twitter
+      def tweets query
+        get "/search/twitter", {query: query}
+      end
+
+    end
+
+  end
+end

data/lib/datarank/locations.rb

@@ -0,0 +1,24 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with geocoded data
+    module Locations
+      
+      # Fetch geocoded comments for a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def locations slug
+        get "/topics/#{slug}/location/pins"
+      end
+
+      # Fetch average sentiment for topic broken down into provinces with counts
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def location_sentiment slug
+        get "/topics/#{slug}/location/sentiment"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/reach.rb

@@ -0,0 +1,17 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with a topic's reach data
+    module Reach
+      
+      # Fetch reach counts for topic by day
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def reach_daily slug
+        get "/topics/#{slug}/reach/daily"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/retailers.rb

@@ -0,0 +1,17 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with a topic's correlated retailers
+    module Retailers
+      
+      # Fetch retailers correlated to a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def retailers slug
+        get "/topics/#{slug}/retailers"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/sentiment.rb

@@ -0,0 +1,17 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with a topic's sentiment data
+    module Sentiment
+      
+      # Fetch sentiment for a topic grouped by day
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def sentiment_daily slug
+        get "/topics/#{slug}/sentiment/daily"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/themes.rb

@@ -0,0 +1,32 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with a topic's themes
+    module Themes
+      
+      # Return themes assigned to a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def themes slug
+        get "/topics/#{slug}/themes"
+      end
+
+      # Return trend for a specific theme on a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      # @param theme_id [Integer] Unique ID of theme
+      def themes_trend slug, theme_id
+        get "/topics/#{slug}/themes/trend/#{theme_id}"
+      end
+
+      # Return table for correlation between all themes on a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def themes_correlation slug
+        get "/topics/#{slug}/themes/correlation"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/topics.rb

@@ -1,9 +1,24 @@
 module Datarank
   class Client
+
+    # Module containing methods for interacting with topics
     module Topics
+    
+      # Return all topics
+      #
+      # @option options [1..1000] :limit The number of items to return.
       def all_topics options={}
         get '/topics', options
       end
+
+      # Return single topic by slug
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def find_topic slug
+        get "/topics/#{slug}"
+      end
+    
     end
+
   end
 end

data/lib/datarank/version.rb

@@ -1,3 +1,14 @@
 module Datarank
-  VERSION = "0.2"
+  # A class for managing Datarank's Version
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
 end

data/lib/datarank/volume.rb

@@ -0,0 +1,17 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with topics
+    module Volume
+     
+      # Return volume for a topic grouped by day
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def volume_daily slug
+        get "/topics/#{slug}/volume/daily"
+      end
+
+    end
+
+  end
+end

data/lib/datarank/wordcloud.rb

@@ -0,0 +1,18 @@
+module Datarank
+  class Client
+
+    # Module containing methods for interacting with a topic's word cloud
+    module Wordcloud
+    
+
+      # Return word cloud for a topic
+      #
+      # @param slug [String] A topic's unique identifier slug
+      def wordcloud slug
+        get "/topics/#{slug}/wordcloud"
+      end
+
+    end
+
+  end
+end

data/spec/datarank_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Datarank do
+
+  it "returns a Datarank::Client" do
+    expect(Datarank.client).to be_kind_of Datarank::Client
+  end
+
+  # it "responds to methods on its client" do
+  #   expect(RedditKit.respond_to?(:username)).to be true
+  # end
+
+  # it "forwards methods to its client" do
+  #   expect { RedditKit.username }.not_to raise_error
+  # end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[SimpleCov::Formatter::HTMLFormatter]
+SimpleCov.start
+
+# require 'dotenv'
+# Dotenv.load
+
+require 'datarank'
+require 'rspec'
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end
+
+# The API key for use during testing
+#
+# @return The account's username.
+def datarank_apikey
+  ENV.fetch 'DATARANK_AUTHORIZATION_KEY'
+end
+
+# The API Version for testing
+#
+# @return The account's username.
+def datarank_api_version
+  ENV.fetch 'DATARANK_API_VERSION'
+end
+
+# An Datarank object
+#
+# @return The authenticated client.
+def authenticated_client
+  VCR.use_cassette('authenticated_client') do
+    Datarank::Client.new datarank_apikey, datarank_api_version
+  end
+end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: datarank
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 1.0.0
 platform: ruby
 authors:
 - Addam Hardy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-- !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
-description: '["Ruby Wrapper for the DataRank REST API"]'
+description: Ruby Wrapper for the DataRank REST API
 email:
 - addam@datarank.com
 executables: []
@@ -116,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -127,9 +87,21 @@ files:
 - lib/datarank.rb
 - lib/datarank/client.rb
 - lib/datarank/comments.rb
+- lib/datarank/datasources.rb
+- lib/datarank/fizzle.rb
+- lib/datarank/live.rb
+- lib/datarank/locations.rb
+- lib/datarank/reach.rb
+- lib/datarank/retailers.rb
+- lib/datarank/sentiment.rb
+- lib/datarank/themes.rb
 - lib/datarank/topics.rb
 - lib/datarank/version.rb
-homepage: http://www.datarank.com
+- lib/datarank/volume.rb
+- lib/datarank/wordcloud.rb
+- spec/datarank_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/datarank/datarank-ruby
 licenses: []
 metadata: {}
 post_install_message: 
@@ -152,5 +124,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: '[""]'
-test_files: []
+test_files:
+- spec/datarank_spec.rb
+- spec/spec_helper.rb
 has_rdoc: