awl_tags_twitter 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b58a59a77672a9fbf26fa2a846beacb9d2dd611
-  data.tar.gz: 1565fae962838c8d4a0ea4f00345d1da49e48a17
+  metadata.gz: 681d4e15c326c34421fe0e13a2f6b31635085ca1
+  data.tar.gz: ba7dfc6c47c84f0c39a716eb5db78a79b8761497
 SHA512:
-  metadata.gz: 1f7bf18d6dd160d79cf4c7bb463fb485deea48c611aa58248c2aa021472e750a111b2b2a8d7cd9f09f89ed1e19b68b5e1f0c0ec422c95dce03557ffa57b4b7f1
-  data.tar.gz: 22aba35c2a545919b2f8fc372958076db85e01e27c99bfffb15ca4bdab9e62ae59facbbc63f7395aa13fe8e52e3381b17b30e941a80f2c8a74028b534a4fb81b
+  metadata.gz: 143093d912537e3005e56b9d25de2b2cc64a31166d9594a6ca773e1d822e3b540767bb506f2c880b7b50a52bacbd77a8a15c6a58c15f1a23ecd304f9fc0ca6ab
+  data.tar.gz: b0399953d0af27dae21a2a7beb95ec409bc746b9e7f62cdba518124b18ed6a4d368e94c631888599edf39e9f18a2521d23b0def3154234ef4a5a2556bd5cc2e3

data/README.md

@@ -9,11 +9,17 @@ Grab tags from The Awl posts and tweet them out
 ## Usage
 
 ```
-$ awl_tags_twitter --config /path/to/config/file post
-$ awl_tags_twitter --config /path/to/config/file list
-$ awl_tags_twitter --config /path/to/config/file help
+$ awl_tags_twitter list [--basic | --complex]
+$ awl_tags_twitter cache-all [--dry]
+$ awl_tags_twitter tweet --config /path/to/config/file [--dry]
 ```
 
+### How to retweet a previous Article
+
+1. You should locate the gem installation location
+2. Navigate to the tmp directory, and open articles.json
+3. Remove the article link which you would like to retweet
+
 ## Contributing
 
 1. Fork it ( https://github.com/ellisandy/awl_tags_twitter/fork )
@@ -22,24 +28,3 @@ $ awl_tags_twitter --config /path/to/config/file help
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-## Archecture
-1. Scraper returns a list of URLs
-  * These URLs tie to a specific Article
-  * When the article is initialized it should only have the URL
-  * You can then call Builder which will poll the webservice and grab all the tags
-2. Article
-  * has a URL
-  * has a list of tags
-  * utilizes builder to actually poll teh article and return the tags
-3. Builder
-  * accepts a url
-  * returns an array of tags
-
-## Algorythm
-  * []
-  * Tweet.new(link)
-  * Tweet.add tag
-    * Tweet.add will check if the tweet will be too long with the new tag included
-  * next
-  * tweet add or Tweet.new again
-

data/awl_tags_twitter.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'commander', '~> 4.3'
   spec.add_runtime_dependency 'contracts', '~> 0.12'
   spec.add_runtime_dependency 'terminal-table', '~> 1.5'
+  spec.add_runtime_dependency 'twitter', '~> 5.16'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rspec', '~> 3.2'

data/bin/awl_tags_twitter

@@ -4,25 +4,12 @@ require 'rubygems'
 require 'commander/import'
 require 'scraper'
 require 'terminal-table'
+require 'twitter_client'
 require 'awl_tags_twitter/version'
 
 program :version, AwlTagsTwitter::VERSION
 program :description, 'Grab tags from posts and tweet them out'
 
-command :post do |c|
-  c.syntax = 'awl_tags_twitter post [options]'
-  c.summary = ''
-  c.description = ''
-  c.example 'description', 'command example'
-  c.option '--some-switch', 'Some switch that does something'
-  c.action do # |args, options|
-    scrapper = Scraper.new
-    scrapper.some = 'hello'
-
-    puts scrapper.what
-  end
-end
-
 command :list do |c|
   c.syntax = 'awl_tags_twitter list'
   c.summary = 'List current posts and their tags'
@@ -33,32 +20,89 @@ command :list do |c|
   c.option '--basic', 'Display posts with tags'
   c.option '--complex', 'Display posts with tags split between posts'
   c.action do |_args, options|
-    # Do something or c.when_called Awstags::Commands::List
+    scraper = Scraper.new
+    scraper.retrieve_posts
     if options.basic
-      scraper = Scraper.new
-      scraper.retrieve_posts
+      scraper.subtract_cache
       rows = scraper.articles.map { |a| [a.link, a.tags] }
-      table = Terminal::Table.new rows: rows
-      puts table
     elsif options.complex
-      scraper = Scraper.new
-      scraper.retrieve_posts.map(&:build_tweets)
+      scraper.subtract_cache
+      scraper.articles.map(&:build_tweets)
       rows = scraper.articles.map { |a| [a.link, a.tags, a.tweets] }
-      table = Terminal::Table.new rows: rows
-      puts table
     else
       fail 'provide --basic or --complex'
     end
+    tracker = Tracker.new
+    tracker.read_articles
+    tracker.articles << scraper.articles.map(&:link)
+    tracker.articles.flatten!
+    tracker.write_articles
+
+    table = Terminal::Table.new rows: rows
+    puts table
   end
 end
 
 command :'cache-all' do |c|
   c.syntax = 'awl_tags_twitter cache-all [options]'
-  c.summary = ''
-  c.description = ''
-  c.example 'description', 'command example'
-  c.option '--some-switch', 'Some switch that does something'
-  c.action do |args, options|
-    # Do something or c.when_called Awstags::Commands::Cache-all
+  c.summary = 'Cache all existing articles'
+  c.description = 'This method will call the AWL and save all files to disk.'\
+  'You can use this if there is an issue while attempting to publish a tweet.'
+  c.example 'default', 'awl_tags_twitter cache-all'
+  c.example 'dry-run', 'awl_tags_twitter cache-all --dry-run'
+  c.option '--dry', 'Print which articles would get saved, but don\'t save them'
+  c.action do |_args, options|
+    scraper = Scraper.new
+    scraper.retrieve_posts
+    scraper.subtract_cache
+    rows = scraper.articles.map { |a| [a.link, a.tags] }
+    tracker = Tracker.new
+    tracker.read_articles
+    tracker.articles << scraper.articles.map(&:link)
+    tracker.articles.flatten!
+    tracker.write_articles unless options.dry
+
+    table = Terminal::Table.new rows: rows
+    puts table
+  end
+end
+
+command :tweet do |c|
+  c.syntax = 'awl_tags_twitter tweet'
+  c.summary = 'tweet out any untweeted post.'
+  c.description = 'Grabs a list of all the posts which haven\'t been tweeted' \
+                   'then builds the tweets, and tweets them for you'
+  c.example 'default', 'awl_tags_twitter tweet'
+  c.example 'dry', 'awl_tags_twitter tweet --dry'
+  c.option '--dry', 'Display what tweets would be sent out'
+  c.option '--config STRING', 'Path to the configuration file'
+  c.action do |_args, options|
+    credentials = JSON.parse(File.read(options.config))
+    twitter_client = TwitterClient.new(credentials)
+    fail 'please pass a configuration file' unless options.config
+    p "loading with Config #{options.config}"
+    scraper = Scraper.new
+    scraper.retrieve_posts
+    scraper.subtract_cache
+    scraper.articles.map(&:build_tweets)
+    tracker = Tracker.new
+    tracker.read_articles
+    tracker.articles << scraper.articles.map(&:link)
+    tracker.articles.flatten!
+    rows = scraper.articles.map { |a| [a.tweets] }
+
+    unless options.dry
+      scraper.articles.each do |a|
+        a.tweets.each do |t|
+          twitter_client.update(t)
+        end
+      end
+
+      # push out them tweets
+      tracker.write_articles
+    end
+
+    table = Terminal::Table.new rows: rows
+    puts table
   end
 end

data/lib/article.rb

@@ -46,9 +46,9 @@ class Article
 
   # Filters finds the link inside the .g-tag-box div, pulls the name, then makes
   # the resulting string uppercase.
-  def filter_tags(doc)
+  def filter_tags(document)
     # Filter down and get the tags.
-    @tags = doc.css(TAG_CSS).map(&:children).map(&:text)
+    @tags = document.css(TAG_CSS).map(&:children).map(&:text)
   end
 
   # Opens @link, then parses using Nokogiri

data/lib/awl_tags_twitter/version.rb

@@ -1,5 +1,5 @@
 # Global Version for AwlTagsTwitter
 class AwlTagsTwitter
   # Global Version for AwlTagsTwitter
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/lib/scraper.rb

@@ -1,7 +1,8 @@
-require 'nokogiri'
-require 'rss'
 require 'article'
 require 'contracts'
+require 'nokogiri'
+require 'rss'
+require 'tracker'
 
 # Class for handling RSS feed to grab posts
 class Scraper
@@ -30,6 +31,15 @@ class Scraper
       @articles << Article.new(link)
     end
 
+    # TODO: Only grab the tags for articles that haven't already be tweeted
     @articles.map(&:retrieve_tags)
   end
+
+  Contract C::None => C::ArrayOf[Article]
+  # Subtrack saved artciles from the list of articles
+  def subtract_cache
+    tracker = Tracker.new
+    tracker.read_articles
+    @articles.delete_if { |x| tracker.articles.include?(x.link) }
+  end
 end

data/lib/tracker.rb

@@ -0,0 +1,31 @@
+require 'contracts'
+require 'json'
+
+# Track previous posts in ./tmp/articles.json
+class Tracker
+  include Contracts::Core
+
+  attr_accessor :articles
+
+  # Short cut for Contract
+  C = Contracts
+
+  Contract C::None => C::ArrayOf[String]
+  # reads articles from the ./tmp/articles.json file
+  def read_articles
+    file = JSON.load(File.read("#{Dir.home}/awl_articles.json"))
+    @articles = file['articles']
+
+  rescue JSON::ParserError
+    @articles = []
+  rescue Errno::ENOENT
+    @articles = []
+  end
+
+  Contract C::None => C::Num
+  # writes articles from the ./tmp/articles.json file
+  def write_articles
+    f = File.new("#{Dir.home}/.awl_articles.json", 'w')
+    f.write "{ \"articles\": #{@articles} }"
+  end
+end

data/lib/tweet.rb

@@ -14,15 +14,15 @@ class Tweet
   Contract String => String
   def initialize(link)
     @link = link
-    @post = @link
+    @post = "| #{@link}"
   end
 
   Contract String => String
   # Add tag to @post
   def add(tag)
-    temp_post = "#{tag} | #{@post}"
+    temp_post = "| #{tag} #{@post}"
     if temp_post.length <= 140
-      @post = tag + ' | ' + @post
+      @post = "| #{tag} #{@post}"
     else
       fail Tweet::TagTooLong
     end

data/lib/twitter_client.rb

@@ -0,0 +1,33 @@
+require 'contracts'
+require 'twitter'
+
+# Establishes the Twitter client
+class TwitterClient
+  include Contracts::Core
+
+  # Shortcut for contracts
+  C = Contracts
+
+  Contract Hash => nil
+  def initialize(credentials)
+    # @config = {
+    # consumer_key: '7Jw0Oc7ZVO9NHY5Z5ieYB91Rs',
+    # consumer_secret: 'hjKJVdd2ikwHdD8SMJjDQQOxxw8FmhI22s3oGXtR7u3OllcDqf',
+    # access_token: '794719566966333440-dR7EPJfd6wR5Wc0nhSR1yGZfKmrqPpI',
+    # access_token_secret: 'YWwWVFhRRx84NH2VxjyxnUIiyeT2tEZZiBb8wjQ72ARRX'
+    # }
+    @client = Twitter::REST::Client.new(credentials)
+    fail 'Unable to load your credentials' unless @client.credentials?
+  end
+
+  Contract String => nil
+  # Wrapper for Twitter::Rest::Client.update with retries if too many requests
+  def update(post)
+    @client.update(post)
+  rescue Twitter::Error::TooManyRequests => error
+    # NOTE: Your process could go to sleep for up to 15 minutes but if you
+    # retry any sooner, it will almost certainly fail with the same exception.
+    sleep error.rate_limit.reset_in + 1
+    retry
+  end
+end

data/spec/article_spec.rb

@@ -65,10 +65,10 @@ RSpec.describe Article do
     end
 
     context 'when there is only a few tags' do
-      let(:tags) { ['foo'] }
+      let(:tags) { %w(foo bar) }
 
       it 'returns an array of tweets' do
-        expect(article.build_tweets.first.post).to eq("#{tags.first} | #{link}")
+        expect(article.build_tweets.first.post).to eq("| #{tags.last} | #{tags.first} | #{link}")
       end
       it 'returns only one tweet' do
         expect(article.build_tweets.count).to eq(1)
@@ -98,7 +98,7 @@ RSpec.describe Article do
       it 'returns the array of tweets' do
         article.build_tweets
 
-        expect(article.tweets).to eq(["#{tags.first} | #{link}"])
+        expect(article.tweets).to eq(["| #{tags.first} | #{link}"])
       end
     end
   end

data/spec/scraper_spec.rb

@@ -1,13 +1,12 @@
 require 'scraper'
 
 RSpec.describe Scraper do
-  context '#retrieve_posts' do
-    let(:scraper) { Scraper.new }
+  let(:scraper) { Scraper.new }
 
+  context '#retrieve_posts' do
     it 'responsed', :vcr do
       expect(scraper).to respond_to(:retrieve_posts)
     end
-
     it 'returns an arrays', :vcr do
       expect(scraper.retrieve_posts).to be_kind_of(Array)
     end
@@ -21,7 +20,39 @@ RSpec.describe Scraper do
     end
   end
 
-  context '#posts' do
+  context '#articles' do
     it { should respond_to(:articles) }
   end
+
+  context '#subtract_cache' do
+    let(:article_1) { Article.new('http://domain.com/1') }
+    let(:article_2) { Article.new('http://domain.com/2') }
+    let(:double) { ['foo'] }
+
+    context 'when there are previous articles' do
+      before do
+        allow_any_instance_of(Tracker).to receive(:articles).and_return(['http://domain.com/1'])
+        allow_any_instance_of(Tracker).to receive(:read_articles).and_return(['http://domain.com/1'])
+      end
+
+      it 'does not return the previous articles', :vcr do
+        scraper.instance_variable_set(:@articles, [article_1, article_2])
+        scraper.subtract_cache
+        expect(scraper.articles.map(&:link)).to eq(['http://domain.com/2'])
+      end
+    end
+
+    context 'when there are no previous posts' do
+      before do
+        allow_any_instance_of(Tracker).to receive(:articles).and_return([])
+        allow_any_instance_of(Tracker).to receive(:read_articles).and_return([])
+      end
+
+      it 'returns all posts' do
+        scraper.instance_variable_set(:@articles, [article_1, article_2])
+        scraper.subtract_cache
+        expect(scraper.articles.map(&:link)).to eq(['http://domain.com/1', 'http://domain.com/2'])
+      end
+    end
+  end
 end

data/spec/tracker_spec.rb

@@ -0,0 +1,62 @@
+require 'tracker'
+
+RSpec.describe Tracker do
+  let(:tracker) { Tracker.new }
+  let(:data) { '{ "articles" : [ "https://domain.com/123456" ] }' }
+
+  before do
+    allow(File).to receive(:read).and_return(data)
+  end
+
+  context '#articles' do
+    context 'when the file is populated' do
+      it 'returns an array with urls' do
+        expect(tracker.read_articles).to eq(['https://domain.com/123456'])
+      end
+    end
+
+    context 'when the file does not contain JSON' do
+      let(:data) { ' { "articles": "blah" : "foo" } ' }
+
+      it 'returns an empty array' do
+        expect(tracker.read_articles).to eq([])
+      end
+    end
+
+    context 'when the file does not exist' do
+      let(:data) { '{ "articles": [] }' }
+
+      before do
+        expect(File).to receive(:read).once.and_raise(Errno::ENOENT)
+      end
+
+      it 'returns an empty array' do
+        expect(tracker.read_articles).to eq([])
+      end
+    end
+  end
+
+  context '#read_articles' do
+    it 'returns an array of articles' do
+      expect(tracker.read_articles).to eq(['https://domain.com/123456'])
+    end
+  end
+
+  context '#write_articles' do
+    it { is_expected.to respond_to(:write_articles) }
+
+    context 'when the JSON is valid' do
+      let(:articles) { ['https://domain.com/123456'] }
+
+      before do
+        expect_any_instance_of(File).to receive(:write).and_return(47)
+      end
+
+      it 'it writes the JSON to file' do
+        tracker.instance_variable_set(:@articles, articles)
+        tracker.write_articles
+        expect(tracker.read_articles).to eq(articles)
+      end
+    end
+  end
+end

data/spec/tweet_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Tweet do
     context 'when the tag + @post is < 140' do
       let(:tag) { 'foo' }
       it 'is added' do
-        expect(tweet.add(tag)).to eq("#{tag} | #{link}")
+        expect(tweet.add(tag)).to eq("| #{tag} | #{link}")
       end
     end
     context 'when the tag + @post is > 140' do

data/spec/twitter_client.rb

@@ -0,0 +1,4 @@
+require 'twitter_client'
+
+Rsepc.describe TwitterClient do
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awl_tags_twitter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Jack Ellis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -256,14 +270,17 @@ files:
 - lib/article.rb
 - lib/awl_tags_twitter/version.rb
 - lib/scraper.rb
+- lib/tracker.rb
 - lib/tweet.rb
 - lib/tweet/tag_too_long.rb
-- lib/tweet_builder.rb
+- lib/twitter_client.rb
 - spec/.txt
 - spec/article_spec.rb
 - spec/scraper_spec.rb
 - spec/spec_helper.rb
+- spec/tracker_spec.rb
 - spec/tweet_spec.rb
+- spec/twitter_client.rb
 - spec/version_spec.rb
 homepage: https://github.com/ellisandy
 licenses:
@@ -294,6 +311,8 @@ test_files:
 - spec/article_spec.rb
 - spec/scraper_spec.rb
 - spec/spec_helper.rb
+- spec/tracker_spec.rb
 - spec/tweet_spec.rb
+- spec/twitter_client.rb
 - spec/version_spec.rb
 has_rdoc: 

data/lib/tweet_builder.rb

@@ -1,5 +0,0 @@
-require 'contracts'
-
-# Recursively build tweets and returns a list of Tweets
-class TweetBuilder
-end