postrank-api 0.1.0

data/README.md

@@ -0,0 +1,29 @@
+# Ruby PostRank API Wrapper
+
+PostRank API wrapper for Ruby 1.9.
+
+ * EventMachine & Fibers under the hood - async friendly.
+ * Can be used outside of an EM loop - wrapper will spin up and shut down the reactor on demand.
+
+For complete documentation on all endpoints please see [PostRank API Docs](http://apidocs.postrank.com)
+
+## A few simple examples
+
+    require "postrank-api"
+
+    api = PostRank::API.new('my-appkey')
+
+    # map a site to postrank id's + retrieve feed meta data
+    igvita = api.feed_info('igvita.com')
+
+    # grab the latest stories from igvita.com
+    feed   = api.feed(igvita['id'])
+
+    # grab the top recent post from igvita.com
+    top    = api.top_posts(igvita['id'], :num => 1)
+
+    # lookup the engagement score for the past two days
+    eng    = api.engagement(igvita['id'], :start => 'yesterday')
+
+    # lookup social metrics for a url
+    metrics = api.metrics('http://www.igvita.com/')

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "postrank-api"
+    gemspec.summary = "PostRank API Wrapper"
+    gemspec.description = gemspec.summary
+    gemspec.email = "ilya@igvita.com"
+    gemspec.homepage = "http://github.com/postrank/postrank-api"
+    gemspec.authors = ["Ilya Grigorik"]
+    gemspec.required_ruby_version = ">= 1.9.1"
+    gemspec.add_dependency('eventmachine', '>= 0.12.9')
+    gemspec.add_dependency('em-http')
+    gemspec.add_dependency('em-synchrony')
+    gemspec.rubyforge_project = "postrank-api"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/postrank-api.rb

@@ -0,0 +1 @@
+require 'postrank-api/api'

data/lib/postrank-api/api.rb

@@ -0,0 +1,140 @@
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+
+require 'digest/md5'
+require 'chronic'
+require 'yajl'
+
+module PostRank
+  class API
+    V2_API_BASE = 'http://api.postrank.com/v2'
+
+    def initialize(appkey)
+      @appkey = appkey
+    end
+
+    def feed_info(feeds, opts = {})
+      req = {
+        :query => {
+          :appkey => @appkey,
+          :noindex => opts[:noindex] || false,
+        },
+        :body => build_body(feeds, 'feed')
+      }
+
+      http = post("#{V2_API_BASE}/feed/info", req)
+      resp = parse(http.response)
+
+      resp.key?('items') ? resp['items'] : resp
+    end
+
+    def feed(feed, opts = {})
+      req = {
+        :query => {
+          :appkey => @appkey,
+          :level  => opts[:level] || 'all',
+          :q      => opts[:q]     || '',
+          :num    => opts[:num]   || 10,
+          :start  => opts[:start] || 0,
+          :id     => feed
+        }
+      }
+
+      http = get("#{V2_API_BASE}/feed/", req)
+      parse(http.response)
+    end
+
+    def top_posts(feed, opts = {})
+      req = {
+        :query => {
+          :appkey => @appkey,
+          :q      => opts[:q]     || '',
+          :num    => opts[:num]   || 10,
+          :id     => feed
+        }
+      }
+
+      http = get("#{V2_API_BASE}/feed/topposts/", req)
+      parse(http.response)
+    end
+
+    def feed_engagement(feeds, opts = {})
+      opts[:start_time] ||= '1 month ago'
+      opts[:end_time]   ||= 'today'
+      opts[:summary]    = true if not opts.key?(:summary)
+
+      req = {
+        :query => {
+          :appkey     => @appkey,
+          :mode       => opts[:mode] || 'daily',
+          :start_time => Chronic.parse(opts[:start_time]).to_i,
+          :end_time   => Chronic.parse(opts[:end_time]).to_i
+        },
+        :body => build_body(feeds, 'feed')
+      }
+
+      req[:query][:summary] = opts[:summary] if opts[:summary]
+
+      http = post("#{V2_API_BASE}/feed/engagement", req)
+      parse(http.response)
+    end
+
+    def metrics(urls, opts = {})
+      reverse = {}
+      urls = [urls].flatten.map do |url|
+        md5 = (url =~ /\w{32}/) ? url : Digest::MD5.hexdigest(url)
+        reverse[md5] = url
+        md5
+      end
+
+      req = {
+        :query => {
+          :appkey => @appkey,
+        },
+        :body => build_body(urls, 'url')
+      }
+
+      http = post("#{V2_API_BASE}/entry/metrics", req)
+      parse(http.response).inject({}) do |hash, v|
+        hash[reverse[v[0]]] = v[1]
+        hash
+      end
+    end
+
+    private
+
+      def parse(data)
+        begin
+          Yajl::Parser.parse(data)
+        rescue Exception => e
+          puts "Failed to parse request:"
+          puts e.message
+          puts e.backtrace[0, 5].join("\n")
+        end
+      end
+
+      def build_body(urls, key)
+        [urls].flatten.map { |e| "#{key}[]=#{e}" }.join("&")
+      end
+
+      def post(url, req)
+        dispatch(:post, url, req)
+      end
+
+      def get(url, req)
+        dispatch(:get, url, req)
+      end
+
+      def dispatch(method, url, req)
+        if EM.reactor_running?
+          http = EM::HttpRequest.new(url).send(method, req)
+        else
+          EM.synchrony do
+            http = EM::HttpRequest.new(url).send(method, req)
+            EM.stop
+          end
+        end
+        http
+      end
+  end
+end

data/postrank-api.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{postrank-api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ilya Grigorik"]
+  s.date = %q{2010-06-03}
+  s.description = %q{PostRank API Wrapper}
+  s.email = %q{ilya@igvita.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/postrank-api.rb",
+     "lib/postrank-api/api.rb",
+     "postrank-api.gemspec",
+     "spec/api_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/postrank/postrank-api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
+  s.rubyforge_project = %q{postrank-api}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{PostRank API Wrapper}
+  s.test_files = [
+    "spec/api_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_runtime_dependency(%q<em-http>, [">= 0"])
+      s.add_runtime_dependency(%q<em-synchrony>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_dependency(%q<em-http>, [">= 0"])
+      s.add_dependency(%q<em-synchrony>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+    s.add_dependency(%q<em-http>, [">= 0"])
+    s.add_dependency(%q<em-synchrony>, [">= 0"])
+  end
+end
+

data/spec/api_spec.rb

@@ -0,0 +1,150 @@
+require 'spec'
+require 'lib/postrank-api'
+require 'pp'
+
+describe PostRank::API do
+  IGVITA = '421df2d86ab95100de7dcc2e247a08ab'
+  EVERBURNING = 'cb3e81ac96fb0ada1212dfce4f329474'
+
+  let(:api) { PostRank::API.new('test') }
+
+  it "should initialize with appkey" do
+    lambda {
+      PostRank::API.new('test')
+    }.should_not raise_error
+  end
+
+  describe "FeedInfo API" do
+    it "should query for feed info" do
+      igvita = api.feed_info('igvita.com')
+
+      igvita.class.should == Hash
+      igvita['tags'].class.should == Array
+      igvita['xml'].should match(/igvita/)
+    end
+
+    it "should query for feed info for multiple feeds" do
+      feeds = api.feed_info(['igvita.com', 'everburning.com'])
+      feeds.class.should == Array
+      feeds.size.should == 2
+    end
+
+    it "should return feed info data in-order" do
+      feeds = api.feed_info(['igvita.com', 'everburning.com'])
+      feeds.class.should == Array
+      feeds.first['xml'].should match('igvita.com')
+    end
+  end
+
+  describe "Feed API" do
+    it "should retrieve content of a feed" do
+      igvita = api.feed_info('igvita.com')
+      feed = api.feed(igvita['id'])
+
+      feed.class.should == Hash
+      feed['meta']['title'].should match(/igvita/)
+      feed['items'].size.should == 10
+    end
+
+    it "should retrieve 1 entry from a feed" do
+      EM.synchrony do
+        feed = api.feed(IGVITA, :num => 1)
+
+        feed.class.should == Hash
+        feed['meta']['title'].should match(/igvita/)
+        feed['items'].size.should == 1
+
+        EM.stop
+      end
+    end
+
+    it "should retrieve entries matching a query" do
+      EM.synchrony do
+        feed = api.feed(IGVITA, :q => 'abrakadabra')
+
+        feed.class.should == Hash
+        feed['meta']['title'].should match(/igvita/)
+        feed['items'].size.should == 0
+
+        EM.stop
+      end
+    end
+  end
+
+  describe "Top Posts API" do
+    it "should fetch top posts for a feed" do
+      EM.synchrony do
+        feed = api.top_posts(IGVITA, :num => 1)
+
+        feed.class.should == Hash
+        feed['meta']['title'].should match(/igvita/)
+        feed['items'].size.should == 1
+
+        EM.stop
+      end
+    end
+  end
+
+  describe "Feed Engagement API" do
+    it "should fetch engagement for a feed" do
+      EM.synchrony do
+        eng = api.feed_engagement(IGVITA)
+
+        eng.class.should == Hash
+        eng.keys.size.should == 1
+        eng[IGVITA]['sum'].class.should == Float
+
+        EM.stop
+      end
+    end
+
+    it "should fetch daily engagement for multiple feeds" do
+      EM.synchrony do
+        eng = api.feed_engagement([IGVITA, EVERBURNING], {
+                                    :summary => false,
+                                    :start_time => 'yesterday',
+                                    :end_time => 'today'
+        })
+
+        eng.class.should == Hash
+        eng.keys.size.should == 2
+        eng[IGVITA].keys.size.should == 2
+
+        EM.stop
+      end
+    end
+  end
+
+  describe "Metrics API" do
+    it "should fetch metrics for a collection of urls" do
+      EM.synchrony do
+        metrics = api.metrics(['http://www.igvita.com/', 'http://www.everburning.com/'])
+        metrics.keys.size.should == 2
+
+        metrics['http://www.igvita.com/'].class.should == Hash
+        metrics['http://www.everburning.com/'].class.should == Hash
+
+        EM.stop
+      end
+    end
+
+    it "should fetch metrics via url md5s" do
+      EM.synchrony do
+        metrics = api.metrics('1c1a5357e8bd00128db845b2595d5ebe')
+
+        metrics.keys.size.should == 1
+        metrics['1c1a5357e8bd00128db845b2595d5ebe'].class.should == Hash
+
+        EM.stop
+      end
+    end
+  end
+
+  it "should invoke and kill EM reactor transparently" do
+    metrics = api.metrics('1c1a5357e8bd00128db845b2595d5ebe')
+
+    metrics.keys.size.should == 1
+    metrics['1c1a5357e8bd00128db845b2595d5ebe'].class.should == Hash
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: postrank-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ilya Grigorik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 9
+        version: 0.12.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: em-http
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: em-synchrony
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: PostRank API Wrapper
+email: ilya@igvita.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/postrank-api.rb
+- lib/postrank-api/api.rb
+- postrank-api.gemspec
+- spec/api_spec.rb
+has_rdoc: true
+homepage: http://github.com/postrank/postrank-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 1
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: postrank-api
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: PostRank API Wrapper
+test_files: 
+- spec/api_spec.rb