ebooks 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89faedd51fce5d08320b71bcdc1c66596d03f738
-  data.tar.gz: 0fae632c95ecdc2e76cfc17f988f4f5074153b69
+  metadata.gz: 5b92abdf753365a92607b400fdf303b6e96f5e9a
+  data.tar.gz: ee4a3d4cd0c3b6ebceb504120f0eda5feb87bcde
 SHA512:
-  metadata.gz: ae09c854c570138b325224c1d55070c5b631e2055d38ddbf72d26b8e879c95f4964c5be1afed090606056e70f9b54ec6e14e40f6994950e6428f3c6cdb320b31
-  data.tar.gz: 31b8ff107d3dcc4e7b73b15a2db3f39e855b5c450bb1999f29a2da22548aa18b9e2e64a833fdd4afa8c0f66232c17295e39cdeb9f978f3c1d29db08e92a8830e
+  metadata.gz: 9934d51b0e7905b64b6c35ec05b4de67a28e20650c117849352b698fde1a33a59e43cf741bed03f060b47d35cc493017ef87e3d0135f7180f272b7494741ec4f
+  data.tar.gz: e50bc685459f82a615e68cfeef3a55d7dba77ebdecdef419ecce71fb2133a9aae25ef912b86f15e549ac11f0a239c98f5412117c878e93a392d044f010b81785

data/.gitignore

@@ -15,3 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+dictionary.mmd
+markov_dict.txt
+tweets.csv

data/README.md

@@ -1,6 +1,11 @@
 # Ebooks
 
-Generate your own horse_ebooks by @busterbenson and compiled as a gem by @parkr
+Generate your own horse_ebooks by [@busterbenson][] ([original gist][], [blog post][]) and compiled as a gem by [@parkr][]
+
+[@busterbenson]: http://wayoftheduck.com/
+[original gist]: https://gist.github.com/busterbenson/6695350
+[blog post]: http://wayoftheduck.com/diy-horse-ebooks
+[@parkr]: https://parkermoo.re
 
 ## Installation
 
@@ -16,9 +21,50 @@ Or install it yourself as:
 
     $ gem install ebooks
 
+## Configuration
+
+The `ebooks` executable and `Ebooks.read_config_file` will load in a yaml file
+(`~/.ebooks` by default) if you want to set your own defaults.
+
+Here are the gem's defaults:
+
+```yaml
+:tweets_csv_path: 'tweets.csv'
+:corpus_path:     'markov_dict.txt'
+:dictionary_name: 'dictionary'
+:twitter:
+  :consumer_key: ''
+  :consumer_secret: ''
+  :oauth_token: ''
+  :oauth_token_secret: ''
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+As an API:
+
+```ruby
+config = Ebooks.configuration(my_overrides)
+
+# Generate a sentence and return it
+Ebooks.generate(config)
+
+# Generate sentence and tweet it
+Ebooks.tweet(config)
+
+# Just tweet a sentence
+Ebooks::Twitter.new(config[:twitter]).tweet(my_sentence)
+```
+
+As an executable:
+
+```bash
+# To generate a new horse_ebooks sentence:
+ebooks generate
+
+# To generate a new sentence and tweet it:
+ebooks tweet
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :console do
+  sh "irb -r./lib/ebooks.rb"
+end

data/bin/ebooks

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'ebooks'
+
+config = Ebooks.read_config_file
+
+if ARGV[0] == "generate"
+  puts Ebooks.generate(config)
+elsif ARGV[0] == "tweet"
+  Ebooks.tweet(config)
+else
+  abort "Don't understand '#{ARGV[1]}'. Valid commands are: 'generate', 'tweet'."
+end

data/lib/ebooks.rb

@@ -1,21 +1,50 @@
-require "ebooks/version"
-
 require 'rubygems'
 require 'thread'
 require 'csv'
 require 'twitter'
 require 'marky_markov'
+require 'yaml'
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'ebooks/version'
+require 'ebooks/core_ext'
 
 module Ebooks
   autoload :Generator, 'ebooks/generator'
   autoload :Twitter,   'ebooks/twitter'
 
+  def self.read_config_file(file = '~/.ebooks')
+    contents = File.read(file.sub('~', ENV["HOME"]))
+    YAML.load(contents)
+  end
+
   def self.configuration(overrides = {})
+    {
+      :tweets_csv_path => 'tweets.csv',
+      :corpus_path     => 'markov_dict.txt',
+      :dictionary_name => 'dictionary', # don't include the .mmd
+      :twitter => {
+        :consumer_key       => '',
+        :consumer_secret    => '',
+        :oauth_token        => '',
+        :oauth_token_secret => ''
+      }
+    }.deep_merge(overrides)
+  end
 
+  def self.generate(overrides = {})
+    config = self.configuration(overrides)
+    generator = Ebooks::Generator.new(config)
+
+    generator.generate_sentence
   end
 
-  def self.generate(config = {})
-    config = self.configuration(config)
+  def self.tweet(overrides = {})
+    config = self.configuration(overrides)
+
+    sentence = self.generate(overrides)
 
+    Ebooks::Twitter.new(config[:twitter]).tweet(sentence)
   end
 end

data/lib/ebooks/core_ext.rb

@@ -0,0 +1,15 @@
+class Hash
+  def deep_merge(hash)
+    target = dup
+
+    hash.keys.each do |key|
+      if hash[key].is_a?(Hash) && self[key].is_a?(Hash)
+        target[key] = target[key].deep_merge(hash[key])
+      end
+      
+      target[key] = hash[key]
+    end
+
+    target
+  end
+end

data/lib/ebooks/generator.rb

@@ -1,13 +1,23 @@
 module Ebooks
-  module Generator
+  class Generator
 
-    def self.generate_twitter_corpus(tweets_csv_path = 'tweets.csv', corpus_path = 'markov_dict.txt')
+    attr_accessor :dictionary
+
+    def initialize(config)
+      @tweets_csv_path = config[:tweets_csv_path]
+      @corpus_path     = config[:corpus_path]
+      build_corpus
+      @dictionary_name = config[:dictionary_name]
+      @dictionary      = build_dictionary
+    end
+
+    def generate_twitter_corpus
       # Go to Twitter.com -> Settings -> Download Archive.
       # This tweets.csv file is in the top directory. Put it in the same directory as this script.
-      csv_text = CSV.parse(File.read(tweets_csv_path))
+      csv_text = CSV.parse(File.read(@tweets_csv_path))
 
       # Create a new clean file of text that acts as the seed for your Markov chains
-      File.open(corpus_path, 'w') do |file|
+      File.open(@corpus_path, 'w') do |file|
         csv_text.reverse.each do |row|
           # Strip links and new lines
           tweet_text = row[5].gsub(/(?:f|ht)tps?:\/[^\s]+/, '').gsub(/\n/,' ')
@@ -17,12 +27,32 @@ module Ebooks
       end
     end
 
-    def self.generate_sentence(corpus_path = 'markov_dict.txt')
+    def generate_sentence
       # Run when you want to generate a new Markov tweet
-      markov = MarkyMarkov::Dictionary.new('dictionary') # Saves/opens dictionary.mmd
-      markov.parse_file(corpus_path)
-      tweet_text = markov.generate_n_sentences(2).split(/\#\</).first.chomp.chop
-      markov.save_dictionary!
+      dictionary.generate_n_sentences(2).split(/\#\</).first.chomp.chop
+    end
+
+    private
+
+    def build_corpus
+      unless File.exists?(@corpus_path)
+        generate_twitter_corpus
+      end
+    end
+
+    def build_dictionary
+      if File.exists?(dictionary_path)
+        MarkyMarkov::Dictionary.new(@dictionary_name)
+      else
+        markov = MarkyMarkov::Dictionary.new(@dictionary_name)
+        markov.parse_file(@corpus_path)
+        markov.save_dictionary!
+        markov
+      end
+    end
+
+    def dictionary_path
+      "#{@dictionary_name}.mmd"
     end
 
   end

data/lib/ebooks/twitter.rb

@@ -1,5 +1,5 @@
 module Ebooks
-  module Twitter
+  class Twitter
 
     def initialize(credentials = {})
       @consumer_key        = credentials.fetch(:consumer_key)
@@ -7,15 +7,16 @@ module Ebooks
       @access_token        = credentials.fetch(:oauth_token)
       @access_token_secret = credentials.fetch(:oauth_token_secret)
 
-      Twitter.configure do |config|
+      ::Twitter.configure do |config|
         config.consumer_key    = @consumer_key
         config.consumer_secret = @consumer_secret
       end
     end
 
     def tweet(tweet_text)
-      twitter_client = Twitter::Client.new(:oauth_token => @access_token,
+      twitter_client = ::Twitter::Client.new(:oauth_token => @access_token,
                                     :oauth_token_secret => @access_token_secret)
+      tweet_text = tweet_text.gsub('@', '')[0..139]
       p "#{Time.now}: #{tweet_text}"
       twitter_client.update(tweet_text)
     end

data/lib/ebooks/version.rb

@@ -1,3 +1,3 @@
 module Ebooks
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Parker Moore
@@ -83,7 +83,8 @@ dependencies:
 description: Generate your own horse_ebooks for fun and for profit
 email:
 - parkrmoore@gmail.com
-executables: []
+executables:
+- ebooks
 extensions: []
 extra_rdoc_files: []
 files:
@@ -92,8 +93,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/ebooks
 - ebooks.gemspec
 - lib/ebooks.rb
+- lib/ebooks/core_ext.rb
 - lib/ebooks/generator.rb
 - lib/ebooks/twitter.rb
 - lib/ebooks/version.rb