newsmonitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a5d26f958b21da893945913ab46e9367b9d97b1
+  data.tar.gz: 9996547358ca4e95735dfe44ce9d7b3354a2ca4d
+SHA512:
+  metadata.gz: 2cb150d8eacc602e9c88b06658dafb7c3fb1c6e8bd743e884ccc7c4eba8e45421b014b065270c7fd50fa63e201a1745b69bff538a4d8ebf1d09d5ecf1250002f
+  data.tar.gz: 8e10b1ffba322e808f9cb1a55c09657830a69282eb974fed4a062b975e239d111007641f453ed0e1ab7a31d2d996afe0c275c2b8d002b862729e403429d44393

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# NewsMonitor
+
+[![Build Status](https://travis-ci.org/rainerborene/newsmonitor.svg)](https://travis-ci.org/rainerborene/newsmonitor)
+[![Code Climate](https://codeclimate.com/github/rainerborene/newsmonitor/badges/gpa.svg)](https://codeclimate.com/github/rainerborene/newsmonitor)
+[![Test Coverage](https://codeclimate.com/github/rainerborene/newsmonitor/badges/coverage.svg)](https://codeclimate.com/github/rainerborene/newsmonitor/coverage)
+
+NewsMonitor API wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newsmonitor', require: 'news_monitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newsmonitor
+
+## Usage
+
+```ruby
+# Create the API object
+api = NewsMonitor::API.new username: 'jonhdoe', password: 'pwd'
+
+# Search similar articles grouped by cluster
+clusters = api.search("lavagem")
+
+# Find article by id
+api.find_article(72109310)
+
+# Find cluster by id
+api.find_cluster(7173190)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rainerborene/newsmonitor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Rainer Borene
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+task default: :test

data/lib/news_monitor/api.rb

@@ -0,0 +1,44 @@
+require 'erb'
+require 'httparty'
+require 'nibbler/json'
+
+module NewsMonitor
+  class API
+    include HTTParty
+
+    base_uri 'https://api.spixdiscovery.com:8083'
+
+    def initialize(options={})
+      @auth = {}
+      @auth[:username] = options.fetch :username, ENV['NEWSMONITOR_USERNAME']
+      @auth[:password] = options.fetch :password, ENV['NEWSMONITOR_PASSWORD']
+    end
+
+    def search(query, options={})
+      conditions = ERB::Util.url_encode(query)
+      options.merge! basic_auth: @auth
+      response = get "/search/#{conditions}", options
+      response['results'].map! do |cluster|
+        Cluster.parse(cluster)
+      end
+    end
+
+    def find_article(article_id, options={})
+      options.merge! basic_auth: @auth
+      response = get "/article/#{article_id}", options
+      Article.parse(response)
+    end
+
+    def find_cluster(cluster_id, options={})
+      options.merge! basic_auth: @auth
+      response = get "/cluster/#{cluster_id}", options
+      Cluster.parse response['results'].first
+    end
+
+    private
+
+    def get(path, options)
+      self.class.get(path, options).parsed_response
+    end
+  end
+end

data/lib/news_monitor/article.rb

@@ -0,0 +1,26 @@
+module NewsMonitor
+  class Article < NibblerJSON
+    element :id
+    element :created_at, with: -> (time) { Time.parse time }
+    element :type
+    element :title
+    element :language_code
+    element :url
+    element :published_at, with: -> (time) { Time.parse time }
+    element :directories
+    element :content
+
+    element '.social_metrics.facebook_likes' => :facebook_likes
+    element '.social_metrics.facebook_shares' => :facebook_shares
+    element '.social_metrics.facebook_comments' => :facebook_comments
+    element '.social_metrics.facebook_total' => :facebook_total
+    element '.social_metrics.twitter' => :twitter_shares
+    element '.social_metrics.pinterest' => :pinterest_shares
+    element '.social_metrics.linkedin' => :linkedin_shares
+    element '.social_metrics.google_plusones' => :google_plusones
+
+    elements :publishings, with: Publisher
+    elements :images, with: Image
+    elements :topics, with: Topic
+  end
+end

data/lib/news_monitor/cluster.rb

@@ -0,0 +1,8 @@
+module NewsMonitor
+  class Cluster < NibblerJSON
+    element '.clusterId' => :id
+    element '.clusterSize' => :size
+    element :score
+    elements :articles, with: Article
+  end
+end

data/lib/news_monitor/image.rb

@@ -0,0 +1,9 @@
+module NewsMonitor
+  class Image < NibblerJSON
+    element :url
+    element '.full_url.original' => :full_original_url
+    element '.full_url.300x' => :full_300x_url
+    element :width
+    element :height
+  end
+end

data/lib/news_monitor/publisher.rb

@@ -0,0 +1,12 @@
+module NewsMonitor
+  class Publisher < NibblerJSON
+    element :id
+    element :permalink
+    element :name
+    element :published_at, with: -> (time) { Time.parse time }
+    element :thumbnail
+    element :thumbnail_url
+    element :url
+    element :author
+  end
+end

data/lib/news_monitor/topic.rb

@@ -0,0 +1,8 @@
+module NewsMonitor
+  class Topic < NibblerJSON
+    element :id
+    element :name
+    element :label
+    element :score
+  end
+end

data/lib/news_monitor/version.rb

@@ -0,0 +1,3 @@
+module NewsMonitor
+  VERSION = '0.1.0'
+end

data/lib/news_monitor.rb

@@ -0,0 +1,10 @@
+require 'news_monitor/version'
+
+module NewsMonitor
+  autoload :API,       'news_monitor/api'
+  autoload :Cluster,   'news_monitor/cluster'
+  autoload :Article,   'news_monitor/article'
+  autoload :Publisher, 'news_monitor/publisher'
+  autoload :Image,     'news_monitor/image'
+  autoload :Topic,     'news_monitor/topic'
+end

data/newsmonitor.gemspec

@@ -0,0 +1,25 @@
+require './lib/news_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'newsmonitor'
+  spec.version       = NewsMonitor::VERSION
+  spec.authors       = ['Rainer Borene']
+  spec.email         = ['rainerborene@gmail.com']
+  spec.summary       = %q{NewsMonitor API wrapper}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/rainerborene/newsmonitor'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'nibbler'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'minitest'
+end

data/spec/api_spec.rb

@@ -0,0 +1,55 @@
+require_relative 'minitest_helper'
+
+describe NewsMonitor::API do
+
+  describe '#initialize' do
+    it 'setup authentication given username and password' do
+      api = described_class.new username: 'test', password: 'test2'
+      auth = api.instance_variable_get :@auth
+      auth[:username].must_equal 'test'
+      auth[:password].must_equal 'test2'
+    end
+
+    it 'fallback to environment variables' do
+      ENV['NEWSMONITOR_USERNAME'] = 'test2'
+      ENV['NEWSMONITOR_PASSWORD'] = 'test'
+
+      auth = described_class.new.instance_variable_get :@auth
+      auth[:username].must_equal 'test2'
+      auth[:password].must_equal 'test'
+    end
+  end
+
+  describe '#search' do
+    it 'fetch clusters of articles given the query' do
+      api = described_class.new
+      results = api.search "lavagem", query: { with_info: true, cluster_size: 1 }
+      results.size.must_equal 50
+      results.must_be_instance_of Array
+      results.map(&:class).uniq.must_equal [NewsMonitor::Cluster]
+    end
+  end
+
+  describe '#find_article' do
+    it 'find article with given id' do
+      api = described_class.new
+      article = api.find_article 164240971
+      article.must_be_instance_of NewsMonitor::Article
+      article.published_at.must_be_instance_of Time
+      article.created_at.must_be_instance_of Time
+      article.id.must_equal 164240971
+    end
+  end
+
+  describe '#find_cluster' do
+    it 'find cluster with given id' do
+      api = described_class.new
+      cluster = api.find_cluster 164240971, query: { with_info: true }
+      cluster.must_be_instance_of NewsMonitor::Cluster
+      cluster.id.must_equal 164240971
+      cluster.size.must_equal 1
+      cluster.articles.wont_be :empty?
+    end
+  end
+
+end

data/spec/minitest_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'news_monitor'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'pry'
+
+class MiniTest::Spec
+  def described_class
+    @described_class ||= self.class.ancestors.select {|c| c.respond_to? :desc }[-2].desc
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: newsmonitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rainer Borene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nibbler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: minitest
+  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: NewsMonitor API wrapper
+email:
+- rainerborene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/news_monitor.rb
+- lib/news_monitor/api.rb
+- lib/news_monitor/article.rb
+- lib/news_monitor/cluster.rb
+- lib/news_monitor/image.rb
+- lib/news_monitor/publisher.rb
+- lib/news_monitor/topic.rb
+- lib/news_monitor/version.rb
+- newsmonitor.gemspec
+- spec/api_spec.rb
+- spec/minitest_helper.rb
+homepage: https://github.com/rainerborene/newsmonitor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: NewsMonitor API wrapper
+test_files:
+- spec/api_spec.rb
+- spec/minitest_helper.rb