twingly-analytics 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e31d1b593419817798bfa388cdb2b2d3c74d2708
-  data.tar.gz: 3498b2b18671060c8119017bf9bd6ab07c18f8d4
+  metadata.gz: f5c4ddb79208dbda2a2171067fe2c31cabff9fbc
+  data.tar.gz: 8ce553588c30aba41aecf0b3a469abe2419c33d3
 SHA512:
-  metadata.gz: e85e466d13661942b9f6b54b83dac6b9bb7537cc481525783d8863f3750133ed7e0cd68c71569e6c39d45b8c1d00ef588442415a815dbd7f81bb0276d5d76c00
-  data.tar.gz: 580b72a3b84a9398c57401731f644515e07d4b996bd7d59186543a2a2c865d46e74c59e6b56a3504ea8cb2fb6e38b60c66115439b3f5ab400958c392afa56f8f
+  metadata.gz: ccaef06060bbb5f9c155d6582e8f8a1a43bc557dd0f9de6eb89d6af76755b1e7711c87c77ce541c1e55f9b873678690f228857a31d001102833477e27d9f61d7
+  data.tar.gz: c46959a67fcb05237e4cb3af84674822335cb841bd4b526523cd173e4039bc3033404c46a527f30d31ea184cfec45344f7b4a83d824709cddf1708103a66d437

data/.travis.yml

@@ -1,17 +1,27 @@
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
+- 1.9.3
+- 2.0.0
+- 2.1
+- 2.2
 deploy:
   provider: rubygems
   api_key:
-    secure: "QxMWXTQ3/T+0IQZl3pk3hmdoX8FcXTXEhH7Jn7Ub1A1D5faa8VNnfYsWAPjP6+VRgVfKEjAsHNMyZQNTvudpPPC/2kAwwzPvStyS+y7KnRkjZ9acC7sYVVel6cZ2lcl+t8iHY+19NRBFBWpq/P0eCAcR/Ew0XXaLZnig5h/1mQo="
+    secure: QxMWXTQ3/T+0IQZl3pk3hmdoX8FcXTXEhH7Jn7Ub1A1D5faa8VNnfYsWAPjP6+VRgVfKEjAsHNMyZQNTvudpPPC/2kAwwzPvStyS+y7KnRkjZ9acC7sYVVel6cZ2lcl+t8iHY+19NRBFBWpq/P0eCAcR/Ew0XXaLZnig5h/1mQo=
   gem: twingly-analytics
   gemspec: twingly-analytics-api-ruby.gemspec
   on:
     tags: true
     rvm: 2.2
     repo: twingly/twingly-analytics-api-ruby
+notifications:
+  email: false
+  hipchat:
+    on_success: never
+    on_failure: change
+    template:
+    - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message} (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
+    format: html
+    rooms:
+      secure: KU2mE9mcqvBczfiCTgTsgMmJPyW02AH/0Rzcli7oj3HVbiHGw8t5JlBQWYROF5TPht0kFhGkiwVPl6HUt/VAGxOIBsOp+/8MXR6aK5FkdIw6g8DMKlDjm9a2QijOT9rvat5bZ3l6hm3snojgkI3s9pLKmLq9l+KalAsPcevwKAQ=

data/README.md

@@ -7,10 +7,16 @@ A Ruby gem for Twingly's Analytics API. Twingly is a blog search service that pr
 
 ## Installation
 
-Add to your application's [Gemfile](http://bundler.io/gemfile.html) and then run `bundle`
+Install via RubyGems
+
+```Shell
+gem install twingly-analytics
+```
+
+Or add to your application's [Gemfile](http://bundler.io/gemfile.html) and then run `bundle`
 
 ```Ruby
-gem 'twingly-analytics', github: 'twingly/twingly-analytics-api-ruby'
+gem 'twingly-analytics'
 ```
 
 ## Usage
@@ -29,6 +35,8 @@ result.posts # will include all returned posts
 
 The `twinlgy-analytics` gem talks to a commercial blog search API and requires an API key. Best practice is to set the `TWINGLY_ANALYTICS_KEY` environment variable to the obtained key. `Twingly::Analytics::Client` can be passed a key at initialization if your setup does not allow environment variables.
 
+Example code can be found in [examples/](examples/).
+
 Too learn more about the capabilities of this API you should read the [Twingly Analytics API documentation](https://developer.twingly.com/resources/analytics/).
 
 ## Requirements

data/examples/find_all_posts_mentioning_github.rb

@@ -1,29 +1,29 @@
-require 'set'
-require 'bundler'
 Bundler.require
 
-# Set environment variable TWINGLY_ANALYTICS_KEY
-client = Twingly::Analytics::Client.new
+class AnalyticsPostStream
+  def initialize(keyword, language: nil)
+    # Set environment variable TWINGLY_ANALYTICS_KEY
+    client = Twingly::Analytics::Client.new
+    @query = client.query
+    @query.language = language
+    @query.pattern = "sort-order:asc sort:published #{keyword}"
+  end
 
-finished   = nil
-start_time = Time.new(2013, 01, 01)
-blogs      = Set.new
+  def each
+    loop do
+      result = @query.execute
+      result.posts.each do |post|
+        yield post
+      end
 
-until finished
-  query = client.query
-  query.pattern    = "sort-order:asc sort:published github"
-  query.start_time = start_time
-  query.language   = 'sv'
-  result = query.execute
+      break if result.all_results_returned?
 
-  result.posts.each do |post|
-    blogs.add(post.blog_url)
+      @query.start_time = result.posts.last.published
+    end
   end
-
-  finished = start_time == result.posts.last.published
-  start_time = result.posts.last.published
 end
 
-blogs.each do |url|
-  puts url
+stream = AnalyticsPostStream.new("(github) AND (hipchat OR slack)")
+stream.each do |post|
+  puts post.url
 end

data/examples/hello_world.rb

@@ -0,0 +1,11 @@
+Bundler.require
+
+# Set environment variable TWINGLY_ANALYTICS_KEY
+client = Twingly::Analytics::Client.new
+query = client.query
+query.pattern = '"hello world"'
+query.start_time = Time.now - (24 * 3600) # search last day
+result = query.execute
+result.posts.each do |post|
+  puts post.url
+end

data/lib/twingly-analytics/query.rb

@@ -3,8 +3,7 @@ require 'faraday'
 module Twingly
   module Analytics
     class Query
-      attr_accessor :pattern, :language, :client
-      attr_reader :start_time, :end_time
+      attr_accessor :pattern, :language, :client, :start_time, :end_time
 
       BASE_URL = 'https://api.twingly.com'
       ANALYTICS_PATH = '/analytics/Analytics.ashx'
@@ -21,14 +20,6 @@ module Twingly
         Parser.new.parse(get_response.body)
       end
 
-      def start_time=(time)
-        @start_time = time.strftime("%F %T")
-      end
-
-      def end_time=(time)
-        @end_time = time.strftime("%F %T")
-      end
-
       def url_parameters
         Faraday::Utils.build_query(request_parameters)
       end
@@ -40,20 +31,28 @@ module Twingly
           :key => client.api_key,
           :searchpattern => pattern,
           :documentlang => language,
-          :ts => start_time,
-          :tsTo => end_time,
+          :ts => ts,
+          :tsTo => ts_to,
           :xmloutputversion => 2
         }
       end
 
     private
 
+      def ts
+        start_time.to_time.strftime("%F %T") if start_time
+      end
+
+      def ts_to
+        end_time.to_time.strftime("%F %T") if end_time
+      end
+
       def get_response
         connection = Faraday.new(:url => BASE_URL) do |faraday|
           faraday.request :url_encoded
           faraday.adapter Faraday.default_adapter
         end
-        connection.headers[:user_agent] = 'Ruby'
+        connection.headers[:user_agent] = "Twingly Analytics Ruby Client/#{VERSION}"
         connection.get(ANALYTICS_PATH, request_parameters)
       end
     end

data/lib/twingly-analytics/result.rb

@@ -8,6 +8,10 @@ module Twingly
         @posts ||= []
       end
 
+      def all_results_returned?
+        number_of_matches_returned.to_i == number_of_matches_total.to_i
+      end
+
       def inspect
         matches = "@posts, "
         matches << "@number_of_matches_returned=#{self.number_of_matches_returned}, "

data/lib/twingly-analytics/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Analytics
-    VERSION = '1.0.1'
+    VERSION = "2.0.0"
   end
 end

data/spec/result_spec.rb

@@ -9,6 +9,7 @@ describe Result do
   it { should respond_to :number_of_matches_returned }
   it { should respond_to :number_of_matches_total }
   it { should respond_to :seconds_elapsed }
+  it { should respond_to :all_results_returned? }
 
   context "before query has populated responses" do
     its(:posts) { should be_empty }

data/twingly-analytics-api-ruby.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its", "~> 1"
   spec.add_development_dependency "vcr", "~> 2.6"
   spec.add_development_dependency "webmock", "~> 1.0"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-analytics
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Johan Eckerström
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,14 +104,14 @@ dependencies:
   name: rake
   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: Twingly Analytics is a product from Twingly AB
@@ -129,6 +129,7 @@ files:
 - Rakefile
 - examples/Gemfile
 - examples/find_all_posts_mentioning_github.rb
+- examples/hello_world.rb
 - lib/twingly-analytics.rb
 - lib/twingly-analytics/client.rb
 - lib/twingly-analytics/parser.rb
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby API client for Twingly Analytics
@@ -184,4 +185,3 @@ test_files:
 - spec/result_spec.rb
 - spec/spec_helper.rb
 - spec/vcr_setup.rb
-has_rdoc: