fanswatch 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e3637b918747c94553b75f4d9a57aa6e5e6b04e
-  data.tar.gz: c56ee9df0e9ef5728ed83751c83539d170f3e7b2
+  metadata.gz: edb3f785533dba5470c392c2f72c6806cc377fef
+  data.tar.gz: 4a74de3d6e7af5c49a7986f3355e9a162eb4030c
 SHA512:
-  metadata.gz: 11c00ee81bf709d61ea5d6c88f713b8e5f80c1f119f7a2049f7e5dd5ff2ec60dad038511933aced09982b04a09a50d34dbc0f2e3d46855d3298660bd981fc03a
-  data.tar.gz: 34e2afcfa01de3148f3d93cf34b76c67d426b0e6c1633c2c5b28a977b514545fbd9e8cf6bc17cd07058d3bb375aa6c79bb4a3b5c1a8c2ee6c6a9cec298fbcad0
+  metadata.gz: 9b344ae198261f514b6e8c365df995ab255b040dfd6be8a12dd6a92ea95b9f3d8886deb6f49e06d282d63578267a8483ce87c0d38841f0828533c27c8a4e708d
+  data.tar.gz: ee994011f0b580671d5024d21f46ffa28db51fa383a0c58d464c7ed888032b504cef8c0ffa73c4c1ba2854993d7f6e66e51997d5f0d87f8a257466b4fd7c3635

data/README.md

@@ -1,7 +1,55 @@
 # FansWatch
+[![Gem Version](https://badge.fury.io/rb/fanswatch.svg)](https://badge.fury.io/rb/fanswatch)
+[![Build Status](https://travis-ci.org/wtlin1228/FansWatch.svg?branch=master)](https://travis-ci.org/wtlin1228/FansWatch)
 
-## It will provide an api for tracing the facebook's pages.
+FaceGroup is a gem that specializes in getting data from public Facebook Pages.
 
-## Refactor the api to class variables and class methods done.
+## Installation
 
-## Prepare publishing fanswatch gem now.
+If you are working on a project, add this to your Gemfile: `gem 'fanswatch'`
+
+For ad hoc installation from command line:
+
+```$ gem install fanswatch```
+
+## Setup Facebook Credentials
+
+Please setup your Facebook developer credentials by creating an app profile on Facebook Developer: https://developers.facebook.com – you should get a "client ID" and "client secret".
+
+## Usage
+
+Require FaceGroup gem in your code: `require 'fanswatch'`
+
+Supply your Facebook credentials to our library in one of two ways:
+- Setup environment variables: `ENV[FB_CLIENT_ID]` and `ENV[FB_CLIENT_SECRET]`
+- or, provide them directly to FansWatch:
+
+```
+FansWatch::FbApi.config = { client_id: ENV['FB_CLIENT_ID'],
+                            client_secret: ENV['FB_CLIENT_SECRET'] }
+```
+
+See the following example code for more usage details:
+
+```ruby
+# Access the page
+page = FansWatch::Page.find(
+  id: ENV['FB_PAGE_ID']
+)
+
+puts page.name
+
+feed = page.feed
+
+puts feed.count
+
+page.feed.postings.each do |posting|
+  puts posting.id
+  puts posting.created_time
+  puts posting.message
+  if posting.attachment
+    puts posting.attachment.description
+    puts posting.attachment.url
+  end
+end
+```

data/fanswatch.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'flog', '~> 4.4'
   s.add_development_dependency 'flay', '~> 2.8'
   s.add_development_dependency 'rubocop', '~> 0.42'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
   s.homepage    =  'https://github.com/wtlin1228/FansWatch'
   s.license     =  'MIT'
 end

data/lib/fanswatch/fb_api.rb

@@ -39,6 +39,19 @@ module FansWatch
                   client_secret: ENV['FB_CLIENT_SECRET'] }
     end
 
+    # Get page_id by url
+    #   ex:  http "https://graph.facebook.com/v2.8/cyberbuzz? 
+    #          access_token=1311663858901254|UhNPeFDGUdXZVJwagwNxBK49t-4"
+    #
+    #        {
+    #            "id": "159425621565",
+    #            "name": "Inside 硬塞的網路趨勢觀察"
+    #        }
+    def self.page_id(url)
+      fb_page_name = url.split('/')[3]
+      response = fb_resource(fb_page_name)
+      return response['id']
+    end
 
     # Get the fans page's name and id
     #   ex: @id="159425621565",

data/lib/fanswatch/runner.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module FansWatch
+  # Executable code for file(s) in bin/ folder
+  class Runner
+    def self.run!(args)
+      page_id = args[0] || ENV['FB_PAGE_ID']
+      puts page_id
+      unless page_id
+        puts 'USAGE: fanswatch [page_id]'
+        exit(1)
+      end
+      page = FansWatch::Page.find(id: page_id)
+
+      output_info(page)
+    end
+
+    def self.output_info(page)
+      page_name = page.name
+      separator = Array.new(page.name.length) { '-' }.join
+      page_info =
+        page.feed.postings.first(3).map.with_index do |post, index|
+          posting_info(post, index)
+        end.join
+
+      [page_name, separator, page_info].join("\n")
+    end
+
+    def self.posting_info(post, index)
+      [
+        "#{index + 1}: ",
+        message_output(post.message),
+        'Attached: ' + attachment_output(post.attachment),
+        "\n\n"
+      ].join
+    end
+
+    def self.message_output(message)
+      message ? message : '(blank)'
+    end
+
+    def self.attachment_output(attachment)
+      attachment ? attachment.url.to_s : '(none)'
+    end
+  end
+end

data/lib/fanswatch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FansWatch
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
 require 'simplecov' 
 SimpleCov.start
 
@@ -43,5 +41,4 @@ VCR.configure do |c|
   c.filter_sensitive_data('<CLIENT_ID>') { ENV['FB_CLIENT_ID'] }
   c.filter_sensitive_data('<CLIENT_SECRET>') { ENV['FB_CLIENT_SECRET'] }
 
-  c.ignore_hosts 'codeclimate.com'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fanswatch
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Wei-Tang Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -150,20 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.42'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 description: Extracts feed, postings, and attachments from FB fans pages
 email:
 - wtlin0711@gmail.com
@@ -186,6 +172,7 @@ files:
 - lib/fanswatch/feed.rb
 - lib/fanswatch/page.rb
 - lib/fanswatch/posting.rb
+- lib/fanswatch/runner.rb
 - lib/fanswatch/version.rb
 - spec/fanswatch_spec.rb
 - spec/fixtures/results.yml