fb_utils 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+*.swp
+*.swo
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    fb_utils (0.0.1)
+      activesupport
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    fakeweb (1.3.0)
+    i18n (0.5.0)
+    multi_json (1.0.3)
+    rake (0.9.2.2)
+    shoulda-context (1.0.0)
+    vcr (1.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  fb_utils!
+  rake
+  shoulda-context
+  vcr

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Lukasz Krystkowiak
+
+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/README.md

@@ -0,0 +1,59 @@
+# FbUtils
+
+fb_utils is Ruby gem that lets you get and save facebook comments.  
+You can save comment in txt or csv file.  
+# Installation
+Type 
+
+```ruby
+gem install fb_utils
+```
+
+or 
+
+add this to your Gemfile and run the bundle command
+
+```ruby
+gem 'fb_utils'
+```
+
+#Usage
+### Get comments
+If you need to just get comments, call get method with URL
+
+```ruby
+# return Array of comments
+comments = FbUtils::Comment.get('http://www.example.com')
+comment = comments.first
+puts comment.id				#=> "388101711259_17396935"
+puts comment.message		#=> "Hello world"
+puts comment.created_time	#=> "2011-07-26T01:23:34+0000"
+puts comment.from_name		#=> "Lukasz Kr"
+puts comment.from_id		#=> "123456789101112"
+```
+
+### Save comments
+In order to save comments in file system, call save method with URL and file name.  
+You can choose txt or csv file type (or write your own writer).  
+Default is txt.
+
+
+```ruby
+# Save comments in example_com.txt file
+FbUtils::Comment.save('http://www.example.com', 'example_com')
+
+# Save comments in example_com.csv file
+FbUtils::Comment.save('http://www.example.com', 'example_com', :format => :csv)
+
+# For csv file you can pass additional parameters
+FbUtils::Comment.save('http://www.example.com', 'example_com',
+		:format => :csv,
+        :fields_terminated_by => ";", 
+        :fields_enclosed_by => "'", 
+        :lines_terminated_by => "\n"
+)
+```
+
+# References
+http://developers.facebook.com/docs/reference/plugins/comments/
+

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'fb_utils'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/fb_utils.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fb_utils/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fb_utils"
+  s.version     = FbUtils::VERSION
+  s.authors     = ["Lukasz Krystkowiak"]
+  s.email       = ["lukasz.krystkowiak@gmail.com"]
+  s.homepage    = "https://github.com/lukkry/fb_utils"
+  s.summary     = %q{Get Facebook comments and save those in txt, csv file.}
+  s.description = %q{Get Facebook comments and save those in txt, csv file.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "shoulda-context"
+end
+

data/lib/fb_utils/comment.rb

@@ -0,0 +1,59 @@
+module FbUtils
+  class Comment
+    LINK = "http://graph.facebook.com/comments/?ids="
+
+    attr_accessor :id, :message, :created_time, :from_name, :from_id
+
+    def initialize(hash={})
+      return if hash.empty?
+      @id = hash["id"]
+      @from_name = hash["from"]["name"]
+      @from_id = hash["from"]["id"]
+      @message = hash["message"]
+      @created_time = hash["created_time"]
+    end
+
+    def to_s
+      to_array.join(' ')
+    end
+
+    def to_array
+      [@id, @message, @from_name, @from_id, @created_time]
+    end
+
+    # Get comments and save these in file system
+    #
+    # The rightmost argument is an optional hash of options, 
+    # which is pass further to particular writer, specified from :format key
+    # Default is: :format => 'txt'
+    #
+    # For example: 
+    #
+    #   FbUtils::Comment.save('http://www.example.com', 'example_com')
+    #
+    #   FbUtils::Comment.save('http://www.example.com', 'example_com',
+    #     :format => :csv,
+    #     :fields_terminated_by => ";", 
+    #     :fields_enclosed_by => "'", 
+    #     :lines_terminated_by => "\n"
+    def self.save(href, filename, *args)
+      options = args.extract_options!
+      options[:format] ||= "txt"
+
+      comments = get(href)
+      writer = "FbUtils::Writer::#{options[:format].to_s.camelize}".constantize.new(filename, options)
+      writer.write(comments)
+      comments
+    end
+
+    # Get comments related to href
+    # Return array of comments
+    def self.get(href)
+      result = JSON.parse(Net::HTTP.get_response(URI(LINK + href)).body)
+      data = result[href]["data"]
+      data.inject([]) do |comments, c|
+        comments << Comment.new(c)
+      end
+    end
+  end
+end

data/lib/fb_utils/string.rb

@@ -0,0 +1,5 @@
+class String
+  def surround(affix)
+    affix + self + affix
+  end
+end

data/lib/fb_utils/version.rb

@@ -0,0 +1,3 @@
+module FbUtils
+  VERSION = "0.0.1"
+end

data/lib/fb_utils/writers/base.rb

@@ -0,0 +1,19 @@
+module FbUtils
+  module Writer
+    class Base
+      attr_accessor :filename, :options
+
+      def initialize(filename, options={})
+        @options = options
+        @options[:format] ||= "txt"
+        @filename = File.basename(filename, ".#{options[:format]}") + ".#{options[:format]}"
+        f = File.new(@filename, "w")
+        f.close
+      end
+
+      def write
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/fb_utils/writers/csv.rb

@@ -0,0 +1,22 @@
+module FbUtils
+  module Writer
+    class Csv < FbUtils::Writer::Base
+      def write(arr)
+        @options = {
+          :fields_terminated_by => ";", 
+          :fields_enclosed_by => "\"", 
+          :lines_terminated_by => "\n"
+        }.merge(@options)
+
+        File.open(@filename, "w") do |f|
+          arr.each{ |a|
+            fields = a.to_array.collect{|x| x.surround(@options[:fields_enclosed_by])} 
+            fields = fields.join(@options[:fields_terminated_by])
+            fields.insert(-1, @options[:lines_terminated_by])
+            f.puts fields 
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fb_utils/writers/txt.rb

@@ -0,0 +1,13 @@
+module FbUtils
+  module Writer
+    class Txt < Writer::Base
+      def write(arr)
+        File.open(@filename, "w") do |f|
+          arr.each{ |a|
+            f.puts a.to_array.join(' ')
+          }
+        end
+      end
+    end
+  end
+end

data/lib/fb_utils.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'active_support/all'
+require 'fb_utils/string'
+
+module FbUtils
+  autoload :Comment,  'fb_utils/comment'
+
+  module Writer
+    autoload :Base, 'fb_utils/writers/base'
+    autoload :Txt,  'fb_utils/writers/txt'
+    autoload :Csv,  'fb_utils/writers/csv'
+  end
+end

data/test/comment_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class CommentTest < Test::Unit::TestCase
+  context "Comment" do
+    should "get comments from Facebook" do
+      VCR.use_cassette('poland_com') do
+        comments = FbUtils::Comment.get("http://poland.com")
+        assert_kind_of Array, comments
+        assert_equal "hey there!", comments[0].message
+        assert_equal "10150114889322623_19119228", comments[0].id
+        assert_equal "1039207562", comments[0].from_id
+        assert_equal "Lukasz Kr", comments[0].from_name
+      end
+    end
+
+    should "get comments from Facebook and save them in txt, csv file" do
+      VCR.use_cassette('poland_com') do
+        comments = FbUtils::Comment.save("http://poland.com", "poland_com")
+        c = comments.first
+        assert_kind_of Array, comments
+
+        assert File.exists?("poland_com.txt")
+        File.open("poland_com.txt") do |f|
+          assert_equal "#{c.to_array.join(' ')}\n", f.readline
+        end
+        File.delete("poland_com.txt")
+
+        comments = FbUtils::Comment.save("http://poland.com", "poland_com", :format => :csv)
+        File.open("poland_com.csv") do |f|
+          assert_equal "\"#{c.id}\";\"#{c.message}\";\"#{c.from_name}\";\"#{c.from_id}\";\"#{c.created_time}\"\n", f.readline
+        end
+        File.delete("poland_com.csv")
+      end
+    end
+  end
+end

data/test/fixtures/vcr_cassettes/poland_com.yml

@@ -0,0 +1,61 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://graph.facebook.com:80/comments/?ids=http://poland.com
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      access-control-allow-origin:
+      - ! '*'
+      cache-control:
+      - private, no-cache, no-store, must-revalidate
+      content-type:
+      - text/javascript; charset=UTF-8
+      etag:
+      - ! '"410e0d777d51e246753ba20ce54db4633417e64d"'
+      expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      pragma:
+      - no-cache
+      x-fb-rev:
+      - '473143'
+      x-fb-server:
+      - 10.32.42.122
+      x-cnection:
+      - close
+      date:
+      - Wed, 16 Nov 2011 16:03:29 GMT
+      content-length:
+      - '3781'
+    body: ! '{"http:\/\/poland.com":{"data":[{"id":"10150114889322623_19119228","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"hey there!","created_time":"2011-10-28T07:46:16+0000"},{"id":"10150114889322623_19119241","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"hey there again!","created_time":"2011-10-28T07:47:37+0000"},{"id":"10150114889322623_19119248","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"Programming motherfucker manifesto!","created_time":"2011-10-28T07:48:04+0000"},{"id":"10150114889322623_19119317","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"lkkl","created_time":"2011-10-28T07:58:14+0000"},{"id":"10150114889322623_19119354","from":{"name":"Lucy
+      Moore","id":"100002075427828"},"message":"blah","created_time":"2011-10-28T08:02:36+0000"},{"id":"10150114889322623_19119433","from":{"name":"Lucy
+      Moore","id":"100002075427828"},"message":"hello world","created_time":"2011-10-28T08:12:36+0000"},{"id":"10150114889322623_19119488","from":{"name":"Lucy
+      Moore","id":"100002075427828"},"message":"ruby on rails, love it.","created_time":"2011-10-28T08:20:32+0000"},{"id":"10150114889322623_19119508","from":{"name":"Lucy
+      Moore","id":"100002075427828"},"message":"love it","created_time":"2011-10-28T08:23:09+0000"},{"id":"10150114889322623_19199110","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"kol","created_time":"2011-11-02T14:56:10+0000"},{"id":"10150114889322623_19199142","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"kjh","created_time":"2011-11-02T14:59:54+0000"},{"id":"10150114889322623_19199428","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"huiuhiuh","created_time":"2011-11-02T15:27:36+0000"},{"id":"10150114889322623_19212705","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"dskaj","created_time":"2011-11-03T08:43:49+0000"},{"id":"10150114889322623_19212964","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"lok","created_time":"2011-11-03T09:21:40+0000"},{"id":"10150114889322623_19216328","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"hello world","created_time":"2011-11-03T15:02:01+0000"},{"id":"10150114889322623_19277426","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"kol","created_time":"2011-11-07T14:40:22+0000"},{"id":"10150114889322623_19277557","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"oo","created_time":"2011-11-07T14:49:03+0000"},{"id":"10150114889322623_19279743","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"jui","created_time":"2011-11-07T17:28:24+0000"},{"id":"10150114889322623_19279800","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"kiop","created_time":"2011-11-07T17:30:52+0000"},{"id":"10150114889322623_19279808","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"tyu","created_time":"2011-11-07T17:31:26+0000"},{"id":"10150114889322623_19279822","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"ert","created_time":"2011-11-07T17:32:00+0000"},{"id":"10150114889322623_19279833","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"bnm","created_time":"2011-11-07T17:32:35+0000"},{"id":"10150114889322623_19279850","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"nm","created_time":"2011-11-07T17:33:35+0000"},{"id":"10150114889322623_19279858","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"zxc","created_time":"2011-11-07T17:34:08+0000"},{"id":"10150114889322623_19294062","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"polska","created_time":"2011-11-08T13:45:05+0000"},{"id":"10150114889322623_19294081","from":{"name":"Lukasz
+      Kr","id":"1039207562"},"message":"hoi","created_time":"2011-11-08T13:47:10+0000"}],"paging":{"next":"http:\/\/graph.facebook.com\/comments?ids=http\u00253A\u00252F\u00252Fpoland.com&limit=25&offset=25"}}}'
+    http_version: '1.1'

data/test/support/vcr.rb

@@ -0,0 +1,6 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  c.stub_with :fakeweb
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "fb_utils")
+require 'test/unit'
+require "shoulda/context"
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/test/writers/base_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class BaseTest < Test::Unit::TestCase
+  should "create blank file during initialization, default format: txt" do
+    writer = FbUtils::Writer::Base.new("test")
+    assert File.exists?("test.txt")
+    assert_raise NotImplementedError do
+      writer.write
+    end
+    File.delete("test.txt")
+  end
+end

data/test/writers/csv_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class CsvTest < Test::Unit::TestCase
+  should "write to csv file" do
+    VCR.use_cassette('poland_com') do
+      comments = FbUtils::Comment.get("http://poland.com")
+      writer = FbUtils::Writer::Csv.new("test", :format => "csv", :fields_terminated_by => ";", :fields_enclosed_by => "'", :lines_terminated_by => "\n")
+      writer.write(comments)
+      c = comments.first
+      File.open("test.csv") do |f|
+        assert_equal "'#{c.id}';'#{c.message}';'#{c.from_name}';'#{c.from_id}';'#{c.created_time}'\n", f.readline
+      end
+      File.delete("test.csv")
+    end
+  end
+end

data/test/writers/txt_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class TxtTest < Test::Unit::TestCase
+  should "write to txt file" do
+    VCR.use_cassette('poland_com') do
+      comments = FbUtils::Comment.get("http://poland.com")
+      writer = FbUtils::Writer::Txt.new("test", :format => "txt")
+      writer.write(comments)
+      File.open("test.txt") do |f|
+        assert_equal "#{comments.first.to_array.join(' ')}\n", f.readline
+      end
+      File.delete("test.txt")
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: fb_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lukasz Krystkowiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &82125440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *82125440
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &82125230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *82125230
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &82125020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82125020
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &82124810 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82124810
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &82124600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82124600
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: &82124390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82124390
+description: Get Facebook comments and save those in txt, csv file.
+email:
+- lukasz.krystkowiak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fb_utils.gemspec
+- lib/fb_utils.rb
+- lib/fb_utils/comment.rb
+- lib/fb_utils/string.rb
+- lib/fb_utils/version.rb
+- lib/fb_utils/writers/base.rb
+- lib/fb_utils/writers/csv.rb
+- lib/fb_utils/writers/txt.rb
+- test/comment_test.rb
+- test/fixtures/vcr_cassettes/poland_com.yml
+- test/support/vcr.rb
+- test/test_helper.rb
+- test/writers/base_test.rb
+- test/writers/csv_test.rb
+- test/writers/txt_test.rb
+homepage: https://github.com/lukkry/fb_utils
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Get Facebook comments and save those in txt, csv file.
+test_files: []