smartstories 7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d26602f7f9ce9279bf889b4447b3064d9be0da85
+  data.tar.gz: 78731afc631ac2f8549fc4e27fd587f068f5123c
+SHA512:
+  metadata.gz: 1cc5b66f78a4999b748565ef4de1dfed9cb09d85b338272348a35404ede0d5f62d103cf29eff5e1d15bc189600e70d2904a84d65f9f6f5e79d9a4dc065d3eeb4
+  data.tar.gz: 3da483c63636c775ce6cece6996dd2ce98cea427a7c10ca404d9a9fcac5e50a4a0e9108c9ecce3e1bb6d7442695863d28bd05fd1606b8789e277b92d54ded472

data/lib/smartstories.rb

@@ -0,0 +1,16 @@
+require "httparty"
+require "json"
+require "logger"
+
+require_relative "smartstories/errors"
+require_relative "smartstories/config"
+require_relative "smartstories/request"
+require_relative "smartstories/client"
+
+module Smartstories
+  class << self
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/smartstories/api.rb

@@ -0,0 +1,15 @@
+require 'smartstories/api/article'
+require 'smartstories/api/breaking'
+require 'smartstories/api/conversation'
+require 'smartstories/api/influencer'
+require 'smartstories/api/geo'
+require 'smartstories/api/media'
+require 'smartstories/api/people'
+require 'smartstories/api/picture'
+require 'smartstories/api/recent'
+require 'smartstories/api/sentiment'
+require 'smartstories/api/trending'
+require 'smartstories/api/volume'
+
+require 'smartstories/node'
+require 'smartstories/monitor_subscription'

data/lib/smartstories/api/article.rb

@@ -0,0 +1,15 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#articles-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Article
+      extend Api::Util
+
+      def self.news(topic_ids, opts)
+        opts[:count] ||= 50
+        http.get("/api/v1/articles", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/breaking.rb

@@ -0,0 +1,19 @@
+# For v1 reference:
+# http://api.timelinelabs.net:8888/static/docs/rest.html#tracker-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Breaking
+      extend Api::Util
+
+      def self.for_topics(topic_ids, filter: nil, **common_options)
+        query = common_parameters(topic_ids, common_options)
+        query[:filter] = filter if filter
+        query[:breaking] = true
+
+        http.get("/api/v1/tracker", query)
+      end
+    end
+  end
+end

data/lib/smartstories/api/conversation.rb

@@ -0,0 +1,15 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#conversation-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Conversation
+      extend Api::Util
+
+      def self.conversations(topic_ids, opts)
+        opts[:count] ||= 25
+        http.get("/api/v1/conversations", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/geo.rb

@@ -0,0 +1,27 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#geo-resource
+
+module Smartstories
+  module Api
+    module Geo
+      extend Api::Util
+
+      def self.for_topics(topic_ids, start_time: start_time, end_time: end_time, **common_options)
+        query = common_parameters(topic_ids, common_options)
+        query[:starttime] = start_time
+        query[:endtime] = end_time
+
+        http.get("/api/v1/geo", query)
+      end
+
+    private
+
+      def self.start_time
+        Time.now.utc.to_i
+      end
+
+      def self.end_time
+        (Time.now - 86400).utc.to_i
+      end
+    end
+  end
+end

data/lib/smartstories/api/influencer.rb

@@ -0,0 +1,15 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#influencers-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Influencer
+      extend Api::Util
+
+      def self.influencers(topic_ids, opts)
+        opts[:count] ||= 75
+        http.get("/api/v1/influencers", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/media.rb

@@ -0,0 +1,15 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#media-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Media
+      extend Api::Util
+
+      def self.videos(topic_ids, opts)
+        opts[:count] ||= 50
+        http.get("/api/v1/media", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/people.rb

@@ -0,0 +1,14 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#people-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module People
+      extend Api::Util
+
+      def self.for_topics(topic_ids, opts)
+        http.get("/api/v1/people", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/picture.rb

@@ -0,0 +1,14 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#pictures-resource
+
+module Smartstories
+  module Api
+    module Picture
+      extend Api::Util
+
+      def self.photos(topic_ids, opts)
+        opts[:count] = 50
+        http.get("/api/v1/pics", common_parameters(topic_ids, opts))
+      end
+    end
+  end
+end

data/lib/smartstories/api/recent.rb

@@ -0,0 +1,13 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#recent-resource
+
+module Smartstories
+  module Api
+    module Recent
+      extend Api::Util
+
+      def self.for_topics(topic_ids, **extraneous)
+        http.get("/api/v1/recent", :topics => topic_ids.join(','))
+      end
+    end
+  end
+end

data/lib/smartstories/api/sentiment.rb

@@ -0,0 +1,26 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#sentiment-resource
+
+module Smartstories
+  module Api
+    module Sentiment
+      extend Api::Util
+
+      def self.sentiment(topic_ids, opts)
+        opts[:type] = 'volume'
+        raw_sentiment(topic_ids, opts)
+      end
+
+      def self.sentiment_ts(topic_ids, opts)
+        opts[:type] = 'ts'
+        raw_sentiment(topic_ids, opts)
+      end
+
+      def self.raw_sentiment(topic_ids, opts)
+        query = common_parameters(topic_ids, opts)
+        query[:type] = opts[:type]
+        query.delete(:count)
+        http.get("/api/v1/sentiment", query)
+      end
+    end
+  end
+end

data/lib/smartstories/api/trending.rb

@@ -0,0 +1,19 @@
+# http://api.timelinelabs.net:8888/static/docs/rest.html#tracker-resource
+require 'smartstories/api/util'
+
+module Smartstories
+  module Api
+    module Trending
+      extend Api::Util
+
+      def self.for_topics(topic_ids, filter: nil, count: 100, **common_options)
+        query = common_parameters(topic_ids, common_options)
+        query[:count] = count
+        query[:breaking] = false
+        query[:filter] = filter if filter
+
+        http.get("/api/v1/tracker", query)
+      end
+    end
+  end
+end

data/lib/smartstories/api/util.rb

@@ -0,0 +1,19 @@
+module Smartstories
+  module Api
+    module Util
+      def common_parameters(topic_ids, count: 10, interval: 3600, starttime: nil, endtime: nil, **extraneous)
+        query = {}
+        query[:topics] = topic_ids.join(',') if topic_ids
+        query[:starttime] = starttime if starttime
+        query[:endtime] = endtime if endtime
+        query[:interval] = interval if interval
+        query[:count] = count if count
+        query
+      end
+
+      def http
+        Smartstories::Request.new
+      end
+    end
+  end
+end

data/lib/smartstories/api/volume.rb

@@ -0,0 +1,34 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#volume-resource
+
+module Smartstories
+  module Api
+    module Volume
+      extend Api::Util
+
+      def self.messages_timeline(topic_ids, opts)
+        raw_volume(topic_ids, opts)
+      end
+
+      def self.volume_ts(topic_ids, opts)
+        raw_volume(topic_ids, opts)
+      end
+
+      def self.volume_unique(topic_ids, opts)
+        opts[:type] = 'thread'
+        raw_volume(topic_ids, opts)
+      end
+
+      def self.volume(topic_ids, opts)
+        opts[:type] = 'volume'
+        raw_volume(topic_ids, opts)
+      end
+
+      def self.raw_volume(topic_ids, opts)
+        query = common_parameters(topic_ids, opts)
+        query[:type] = opts[:type] if opts[:type]
+        query.delete(:count)
+        http.get("/api/v1/volume", query)
+      end
+    end
+  end
+end

data/lib/smartstories/client.rb

@@ -0,0 +1,76 @@
+require 'smartstories/api'
+
+module Smartstories
+  class Client
+    def initialize(topic_ids = [])
+      @topic_ids = topic_ids
+    end
+
+    def recent(opts = {})
+      Api::Recent.for_topics(@topic_ids, opts)
+    end
+
+    def breaking(opts = {})
+      Api::Breaking.for_topics(@topic_ids, opts)
+    end
+
+    def trending(opts = {})
+      Api::Trending.for_topics(@topic_ids, opts)
+    end
+
+    def geo(opts = {})
+      Api::Geo.for_topics(@topic_ids, opts)
+    end
+
+    def people(opts = {})
+      Api::People.for_topics(@topic_ids, opts)
+    end
+#################################################
+
+###TOTALLY OLD SHIT, MAYBE WILL DIE##############
+###MAYBE IN SUPPORT OF PANELS####################
+    def photos(opts = {})
+      Api::Picture.photos(@topic_ids, opts)
+    end
+
+    def videos(opts = {})
+      Api::Media.videos(@topic_ids, opts)
+    end
+
+    def influencers(opts = {})
+      Api::Influencer.influencers(@topic_ids, opts)
+    end
+
+    def conversations(opts = {})
+      Api::Conversation.conversations(@topic_ids, opts)
+    end
+
+    def news(opts = {})
+      Api::Article.news(@topic_ids, opts)
+    end
+
+    def messages_timeline(opts = {})
+      Api::Volume.messages_timeline(@topic_ids, opts)
+    end
+
+    def volume(opts = {})
+      Api::Volume.volume(@topic_ids, opts)
+    end
+
+    def volume_ts(opts = {})
+      Api::Volume.volume_ts(@topic_ids, opts)
+    end
+
+    def volume_unique(opts = {})
+      Api::Volume.volume_unique(@topic_ids, opts)
+    end
+
+    def sentiment(opts = {})
+      Api::Sentiment.sentiment(@topic_ids, opts)
+    end
+
+    def sentiment_ts(opts = {})
+      Api::Sentiment.sentiment_ts(@topic_ids, opts)
+    end
+  end
+end

data/lib/smartstories/config.rb

@@ -0,0 +1,21 @@
+module Smartstories
+  class Config
+    class << self
+      attr_reader :host
+      attr_writer :api_key, :logger
+
+      def host=(new_host)
+        @host = new_host
+        Request.base_uri(@host)
+      end
+
+      def logger
+        @logger || Logger.new('/dev/null')
+      end
+
+      def api_key
+        @api_key || raise(MissingApiKey, "Missing SmartStories API key.")
+      end
+    end
+  end
+end

data/lib/smartstories/errors.rb

@@ -0,0 +1,13 @@
+module Smartstories
+  # generic error
+  class Error < StandardError; end
+
+  class MissingApiKey < Smartstories::Error; end
+  class MissingParam < Smartstories::Error; end
+
+  class ParserError < Smartstories::Error; end
+  class MissingError < Smartstories::Error; end
+  class TimeoutError < Smartstories::Error; end
+  class SocketError < Smartstories::Error; end
+  class ServerError < Smartstories::Error; end
+end

data/lib/smartstories/monitor_subscription.rb

@@ -0,0 +1,37 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#monitor-subscriptions
+
+module Smartstories
+  class MonitorSubscription
+    DEFAULT_EXPIRE_DURATION = 1800 # seconds
+
+    def initialize(http=Request.new)
+      @http = http
+    end
+
+    def self.update_environment!(environment_subscription_info)
+      client = self.new
+      client.update(environment_subscription_info)
+    end
+
+    def add(monitor_subscription_info)
+      attrs = format_payload(monitor_subscription_info)
+      @http.post("/api/v1/monitor/subscriptions/#{monitor_subscription_info.environment}", attrs.to_json)
+    end
+
+    def update(monitor_subscription_info)
+      attrs = format_payload(monitor_subscription_info)
+      @http.put("/api/v1/monitor/subscriptions/#{monitor_subscription_info.environment}", attrs.to_json)
+    end
+
+    private
+
+    def format_payload(param)
+      {
+        environment: param.environment,
+        nodes: param.nodes,
+        pusher_prefix: param.pusher_prefix,
+        expire: param.expire
+      }
+    end
+  end
+end

data/lib/smartstories/node.rb

@@ -0,0 +1,47 @@
+# http://api-staging.timelinelabs.net:8888/static/docs/rest.html#nodes
+
+module Smartstories
+  # Maybe the following methods should be at the class level, and they
+  # wrap the API results by calling Node.new(node_json)
+  #   Node.add => wrap newly created node and return Node object
+  #   Node.update => wrap updated node and return Node object
+  #   Node.all => wrap each element of returned array, return array
+  #   Node.find => wrap found node and return Node object
+  #
+  # Downside is that node_info would need to be a private class method and that
+  # we couldn't call Request.new on instantiation, meaning we would have to stub
+  # Request out in our tests.
+  #
+  # Maybe delegate :get, :post, to: Request.new ?
+  #
+  # node_info could be replaced by a NodeInfo or NodeFormatter object?
+  class Node
+    def initialize(http = Request.new)
+      @http = http
+    end
+
+    def add(node)
+      attrs = format_node(node)
+      @http.post("/api/v1/nodes/#{node.uuid}", attrs.to_json)
+    end
+
+    def update(node)
+      attrs = format_node(node)
+      @http.put("/api/v1/nodes/#{node.uuid}", attrs.to_json)
+    end
+
+    def delete(node_uuid)
+      @http.delete("/api/v1/nodes/#{node_uuid}")
+    end
+
+  private
+    def format_node(node)
+      {
+        id: node.id.to_s,
+        uuid: node.uuid,
+        description: node.name,
+        topics: node.topics
+      }
+    end
+  end
+end

data/lib/smartstories/notes

@@ -0,0 +1,24 @@
+Old endpoints:
+
+Completed:
+  trackers: {
+    endpoint: '/api/tracker',
+    count: 100
+  },
+
+  photos: { endpoint: '/api/pics', count: 50 },
+  videos: { endpoint: '/api/media', count: 50 }, #DONE
+  influencers: { endpoint: '/api/influencers', count: 75 }, #DONE
+  conversations: { endpoint: '/api/conversations', count: 25 }, #DONE
+  news: { endpoint: '/api/articles', count: 50 }, #DONE
+  recent: { endpoint: '/api/recent' } #DONE
+  messages_timeline: { endpoint: '/api/volume', count: nil },
+  volume: { endpoint: '/api/volume', count: nil, type: 'volume' },
+  volume_ts: { endpoint: '/api/volume', count: nil },
+  volume_unique: { endpoint: '/api/volume', count: nil, type: 'thread' },
+  sentiment: { endpoint: '/api/sentiment', count: nil, type: 'volume' },
+  sentiment_ts: { endpoint: '/api/sentiment', count: nil, type: 'ts' },
+
+Dead:
+  country_map: { endpoint: '/api/country_map', count: nil },
+  bar_graph: { endpoint: '/api/bar_graph', count: nil },

data/lib/smartstories/request.rb

@@ -0,0 +1,55 @@
+module Smartstories
+  class Request
+    include HTTParty
+    default_timeout 90
+
+    def get(endpoint, query = {})
+      request(:get, endpoint, query)
+    end
+
+    def post(endpoint, query = {})
+      request(:post, endpoint, query)
+    end
+
+    def put(endpoint, query = {})
+      request(:put, endpoint, query)
+    end
+
+    def delete(endpoint)
+      request(:delete, endpoint)
+    end
+
+  private
+    def request(method, endpoint, query = nil)
+      auth = { username: Config.api_key, password: '' }
+      options = { basic_auth: auth }
+      if [:post, :put].include? method
+        options[:body] = query
+        options[:content_type] = 'application/json'
+      else
+        options[:query] = query
+      end
+
+      response = self.class.send(method, endpoint, options)
+
+      case response.code.to_s
+      when "200"
+        JSON.parse(response.body)
+      when "204"
+        true
+      when "404"
+        raise Smartstories::MissingError, "Missing resource: #{response.request.last_uri.to_s}", self.inspect
+      when /^5\d\d$/
+        raise Smartstories::ServerError, "#{response.code} Series error", self.inspect
+      else
+        raise Smartstories::Error, "Error: #{response.request.last_uri.to_s}\n\n#{response.code}", self.inspect
+      end
+    rescue JSON::ParserError
+      raise Smartstories::ParserError
+    rescue Errno::ETIMEDOUT
+      raise Smartstories::TimeoutError
+    rescue ::SocketError
+      raise Smartstories::SocketError
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: smartstories
+version: !ruby/object:Gem::Version
+  version: '7.0'
+platform: ruby
+authors:
+- Timeline Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/smartstories/api/article.rb
+- lib/smartstories/api/breaking.rb
+- lib/smartstories/api/conversation.rb
+- lib/smartstories/api/geo.rb
+- lib/smartstories/api/influencer.rb
+- lib/smartstories/api/media.rb
+- lib/smartstories/api/people.rb
+- lib/smartstories/api/picture.rb
+- lib/smartstories/api/recent.rb
+- lib/smartstories/api/sentiment.rb
+- lib/smartstories/api/trending.rb
+- lib/smartstories/api/util.rb
+- lib/smartstories/api/volume.rb
+- lib/smartstories/api.rb
+- lib/smartstories/client.rb
+- lib/smartstories/config.rb
+- lib/smartstories/errors.rb
+- lib/smartstories/monitor_subscription.rb
+- lib/smartstories/node.rb
+- lib/smartstories/notes
+- lib/smartstories/request.rb
+- lib/smartstories.rb
+homepage: 
+licenses: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: TLL Smartstories Client API Wrapper
+test_files: []