marvel_explorer 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a91887bcc6d75c99bab07490edfd98e2e71c53e1
+  data.tar.gz: c1c0f0805b44f255cf071e282097ae5e124a5c37
+SHA512:
+  metadata.gz: b58a35a38ea4a0d75eaa0e78e3477ea95ed4909175bec1508dc2d0beb9f8bf50bb9fe79228fed3a6f1c3fcedb66c18f81ef86430bc229d1fc1a615ca9ad3b341
+  data.tar.gz: 37e665477ce26413032408f0e4da963831fa1f0b4f77fb315e3790c906948471ac2c86e968ac435a239ee1be36b82c468887b26ba43314590d473bc6704434bb

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env*
+config-dev.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+- 2.1.5
+env:
+  global:
+  - secure: ee8FFvq5vaDa0lZYgvFn5fZ+w+Rt2dnQcsBz/5daZY4pm42iAyxcESnjfr0ViUNDzRxaiBDz8RkcIoeAKalsr9uzTUrsHY5X/B/gji4tzYkDNjE7uLEaA50NJ+EU3tY9eeuNwLOIKH1jNXt5i7DEwwpmognFCf0wxFsoITM2NOo=
+  - secure: VBv4y36Vbkg8RVFxq15xkVrpPk1efCKo24PtW7J4HKoD1MR8isll3/ECI/HmnIJIlpLz/U4Uu2WptUrfjX+d1X5xN/dYwoUewdrBbnG0p5aWggSCIJhS15efLkvoRRAHvm7j4mtwqXwTPT/QBm3wjW1Sea6mfMnYTUZ+VWvSGqE=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marvel_explorer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,38 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+##Copyright (c) 2014 Sam Pikesley
+
+#MIT License
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+##Copyright (c) 2014 Sam Pikesley
+
+#MIT License
+
+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,48 @@
+[![Build Status](https://travis-ci.org/marvelexplorer/marvel_explorer.svg)](https://travis-ci.org/marvelexplorer/marvel_explorer)
+[![Dependency Status](http://img.shields.io/gemnasium/marvelexplorer/marvel_explorer.svg)](https://gemnasium.com/marvelexplorer/marvel_explorer)
+[![Code Climate](http://img.shields.io/codeclimate/github/marvelexplorer/marvel_explorer.svg)](https://codeclimate.com/github/marvelexplorer/marvel_explorer)
+[![Gem Version](http://img.shields.io/gem/v/marvel_explorer.svg)](https://rubygems.org/gems/marvel_explorer)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://marvelexplorer.mit-license.org)
+[![Badges](http://img.shields.io/:badges-6/6-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)
+
+# MarvelExplorer
+
+Uses my [Ultron](http://pikesley.org/projects/ultron) gem to wander from character to character through the [Marvel Comics Data](http://developer.marvel.com/) and drive the [Twitter stream](https://twitter.com/marvel_explorer) and the [Website](http://marvelexplorer.github.io/). You need to set some things up in `~/.marvel_explorer/config.yml`:
+
+    twitter:
+      consumer:
+        key:    a_key
+        secret: a_secret
+      oauth:
+        token:  a_token
+        secret: a_nuvver_secret
+
+    marshal_file: /home/marvelexplorer/.marvel_explorer/last.character
+    jekyll_dir:   /home/marvelexplorer/marvelexplorer.github.io/
+
+You also need some [Ultron configuration](https://github.com/pikesley/ultron/blob/master/README.md) in `~/.ultronrc`:
+
+    PUBLIC_KEY: this_r_public_key
+    PRIVATE_KEY: this_one_r_private_key
+
+Available commands are:
+
+    marvel_explorer update
+
+Gets the next iteration of '_Character A_ appeared in _Comic_ with _Character B_'. Writes YAML into `jekyll_dir` for use by my [Marvel Explorer Jekyll site](https://github.com/marvelexplorer/marvelexplorer.github.io)
+
+    marvel_explorer tweet
+
+Generates and publishes a [Tweet](https://twitter.com/marvel_explorer)
+
+    marvel_explorer publish
+
+Commits and pushes the Jekyll site to Github Pages
+
+    marvel_explorer ranking
+
+Calculates most-featured-characters data, writes YAML for Jekyll site
+
+    marvel_explorer perform
+
+All four of the above tasks

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/bin/marvel_explorer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'marvel_explorer/cli'
+MarvelExplorer::CLI.start

data/config/defaults.yml

@@ -0,0 +1,2 @@
+default_id:   1009351 # Hulk
+tweet_length: 140

data/config.yml

@@ -0,0 +1,3 @@
+marshal_file: spec/fixtures/last.character
+cache_dir:    'tmp/cached_characters/'
+jekyll_dir:   'tmp/'

data/lib/marvel_explorer/characters.rb

@@ -0,0 +1,39 @@
+module MarvelExplorer
+  class Explorer
+    def start_character
+      @start_character ||= begin
+        File.open @config['marshal_file'] do |file|
+          Marshal.load file
+        end
+      rescue
+        Ultron::Characters.find @config['default_id']
+      ensure
+        true
+      end
+    end
+
+    def end_character
+      @end_character ||= begin
+        characters = Ultron::Characters.by_comic comic.id
+        end_character = start_character
+        # we want a different character for the next iteration, obvs.
+        until end_character.id != start_character.id && MarvelExplorer.validate_character(end_character)
+          end_character = characters.sample
+        end
+
+        end_character
+      end
+    end
+
+    def save
+      File.open @config['marshal_file'], 'w' do |file|
+        Marshal.dump end_character, file
+      end
+
+      FileUtils.mkdir_p @config['cache_dir']
+      File.open '%s/%d' % [ @config['cache_dir'], end_character[:id] ], 'w' do |file|
+        Marshal.dump end_character, file
+      end
+    end
+  end
+end

data/lib/marvel_explorer/cli.rb

@@ -0,0 +1,62 @@
+require 'marvel_explorer'
+
+module MarvelExplorer
+  class CLI < Thor
+    desc 'version', 'Print marvel_explorer version'
+    def version
+      puts 'marvel_explorer version %s' % [
+        VERSION
+      ]
+    end
+    map %w(-v --version) => :version
+
+    desc 'update', 'Get the next iteration'
+    def update
+      @me = Explorer.new
+      @me.update
+    end
+    map %w(-u --update) => :update
+
+    desc 'tweet', 'Tweet the current iteration'
+    def tweet
+      @me = Explorer.new
+      @me.tweet
+    end
+    map %w(-t --tweet) => :tweet
+
+    desc 'publish', 'Publish the current iteration to Github Pages'
+    def publish
+      @me = Explorer.new
+      @me.publish
+    end
+    map %w(-p --publish) => :publish
+
+    desc 'ranking', 'Calculate the most-featured-characters data'
+    method_option :commits,
+                  type: :numeric,
+                  default: 96,
+                  desc: 'How many commits to rank over; 96 is 24 hours, 672 is 7 days',
+                  aliases: '-c'
+    method_option :limit,
+                  type: :numeric,
+                  default: 5,
+                  desc: 'Get top N rankings',
+                  aliases: '-l'
+
+    def ranking
+      @me = Explorer.new
+      @me.record_rankings commits: options[:commits], limit: options[:limit]
+    end
+    map %w(-r --ranking) => :ranking
+
+    desc 'perform', 'Update, publish and tweet'
+    def perform
+      @me = Explorer.new
+      @me.update
+      @me.rankings commits: 96
+      @me.rankings commits: 672
+      @me.publish
+      @me.tweet
+    end
+  end
+end

data/lib/marvel_explorer/comic.rb

@@ -0,0 +1,19 @@
+module MarvelExplorer
+  class Explorer
+    def comic
+      @comic ||= begin
+        comics = Ultron::Comics.by_character_and_vanilla_comics start_character.id
+        @comic  = comics.sample
+        until MarvelExplorer.validate_comic @comic
+          @comic = comics.sample
+        end
+        @comic
+      end
+    end
+
+    def series
+      @comic[:title] =~ /(.*) \((.*)\) #(.*)/
+      { name: $1, period: $2 }
+    end
+  end
+end

data/lib/marvel_explorer/explorer.rb

@@ -0,0 +1,23 @@
+module MarvelExplorer
+  class Explorer
+    attr_accessor :config
+
+    def initialize config_file = "#{ENV['HOME']}/.marvel_explorer/config.yml"
+      @config = YAML.load(File.open(File.join(File.dirname(__FILE__), '..', '..', 'config/defaults.yml')))
+      @config.merge! YAML.load File.open config_file
+    end
+
+    def update
+      yamlise
+      save
+    end
+
+    def tweet
+      twitter_client.update tweet_message
+    end
+
+    def publish
+      commit
+    end
+  end
+end

data/lib/marvel_explorer/git.rb

@@ -0,0 +1,19 @@
+module MarvelExplorer
+  class Explorer
+    def commit_message
+      '%s -> %s -> %s' % [
+        yamls['start']['name'],
+        yamls['comic']['series']['name'],
+        yamls['end']['name']
+      ]
+    end
+
+    def commit
+      g = Git.open @config['jekyll_dir']
+
+      g.add '.'
+      g.commit commit_message
+      g.push(g.remote('origin'))
+    end
+  end
+end

data/lib/marvel_explorer/helpers.rb

@@ -0,0 +1,17 @@
+module MarvelExplorer
+  def self.get_year comic
+    DateTime.parse(comic.dates.select { |d| d['type'] == 'onsaleDate' }[0]['date']).year
+  end
+
+  def self.validate_character character
+    character.thumbnail &&
+    character.thumbnail['path'] !~ /not_available/
+  end
+
+  def self.validate_comic comic
+    comic.characters['available'] > 1 &&
+    MarvelExplorer.get_year(comic) > 1900 &&
+    comic.thumbnail &&
+    comic.thumbnail['path'] !~ /not_available/
+  end
+end

data/lib/marvel_explorer/rankings.rb

@@ -0,0 +1,29 @@
+module MarvelExplorer
+  class Explorer
+    def calculate_rankings params
+      params = { commits: 35040, repo: @config['jekyll_dir'], limit: 5 }.merge params
+      g = Git.open params[:repo]
+
+      counts = Hash.new(0)
+
+      g.log(params[:commits])
+      .select{ |c| c.message =~ /\->/ }
+      .map { |c| /(.*) -> (.*) -> (.*)/.match(c.message)[1] }
+      .each { |c| counts[c] += 1 }
+
+      counts.sort_by { |k, v| v }.reverse
+      .map { |k, v| { 'name' => k, 'score' => v } }[0...params[:limit]]
+    end
+
+    def rankings params = {}
+      FileUtils.mkdir_p '%s/_data/' % @config['jekyll_dir']
+      y = File.open '%s/_data/rankings_%d.yml' % [
+        @config['jekyll_dir'],
+        params[:commits],
+      ], 'w'
+
+      y.write calculate_rankings(params).to_yaml
+      y.close
+    end
+  end
+end

data/lib/marvel_explorer/twitter.rb

@@ -0,0 +1,29 @@
+module MarvelExplorer
+  class Explorer
+    def twitter_client
+      twitter_config = {
+        consumer_key:        @config['twitter']['consumer']['key'],
+        consumer_secret:     @config['twitter']['consumer']['secret'],
+        access_token:        @config['twitter']['oauth']['token'],
+        access_token_secret: @config['twitter']['oauth']['secret']
+      }
+      Twitter::REST::Client.new(twitter_config)
+    end
+
+    def tweet_message
+      tm = 'In %s, %s appeared in %s #%s with %s' % [
+        yamls['comic']['year'],
+        yamls['start']['name'],
+        yamls['comic']['series']['name'],
+        yamls['comic']['issue'],
+        yamls['end']['name']
+      ]
+
+      if tm.length > @config['tweet_length'].to_i
+        tm = '%s…' % s[0, @config['tweet_length'].to_i - 1]
+      end
+
+      tm
+    end
+  end
+end

data/lib/marvel_explorer/version.rb

@@ -0,0 +1,3 @@
+module MarvelExplorer
+  VERSION = '0.2.2'
+end

data/lib/marvel_explorer/yamlise.rb

@@ -0,0 +1,76 @@
+module MarvelExplorer
+  class Explorer
+    def yamlise_characters
+      [
+        'start',
+        'end'
+      ].each do |c|
+        h = {
+          'name' => eval("#{c}_character[:name]"),
+          'description' => eval("#{c}_character[:description]"),
+          'url' => eval("#{c}_character[:urls][1]['url']"),
+          'image' => eval("#{c}_character[:thumbnail]")
+        }
+
+        write_yaml h, c
+      end
+    end
+
+    def yamlise_comic
+      h = {
+        'date' => comic[:dates][0]['date'],
+        'year' => Date.parse(comic[:dates][0]['date']).strftime('%Y'),
+        'title' => comic[:title],
+        'issue' => comic[:issueNumber],
+        'series' => {
+          'period' => series[:period],
+          'name' => series[:name]
+        },
+        'url' => comic[:urls][0]['url'],
+        'image' => comic[:thumbnail]
+      }
+
+      write_yaml h, 'comic'
+    end
+
+    def write_yaml h, path
+      FileUtils.mkdir_p '%s/_data/' % @config['jekyll_dir']
+      y = File.open '%s/_data/%s.yml' % [
+        @config['jekyll_dir'],
+        path
+      ], 'w'
+      y.write h.to_yaml
+      y.close
+    end
+
+    def yamlise
+      FileUtils.mkdir_p '%s/_data' % @config['jekyll_dir']
+      %w{ comic characters }.each do |item|
+        eval "yamlise_#{item}"
+      end
+    end
+
+    def yamls
+      @yamls ||= begin
+        yamls = {}
+        %w{ start end comic }.each do |thing|
+          begin
+            file = File.open '%s/_data/%s.yml' % [
+              @config['jekyll_dir'],
+              thing
+            ]
+          rescue Exception
+            update
+            file = File.open '%s/_data/%s.yml' % [
+              @config['jekyll_dir'],
+              thing
+            ]
+          end
+          y = YAML.load file
+          yamls[thing] = y
+        end
+        yamls
+      end
+    end
+  end
+end

data/lib/marvel_explorer.rb

@@ -0,0 +1,19 @@
+require 'date'
+require 'twitter'
+require 'ultron'
+require 'yaml'
+require 'dotenv'
+require 'fileutils'
+require 'date'
+require 'thor'
+require 'git'
+
+require 'marvel_explorer/helpers'
+require 'marvel_explorer/characters'
+require 'marvel_explorer/comic'
+require 'marvel_explorer/explorer'
+require 'marvel_explorer/twitter'
+require 'marvel_explorer/rankings'
+require 'marvel_explorer/git'
+require 'marvel_explorer/yamlise'
+require 'marvel_explorer/version'

data/marvel_explorer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marvel_explorer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'marvel_explorer'
+  spec.version       = MarvelExplorer::VERSION
+  spec.authors       = ['pikesley']
+  spec.email         = ['sam@pikesley.org']
+  spec.summary       = %q{Wander around the Marvel Comics data}
+  spec.description   = %q{}
+  spec.homepage      = 'http://sam.pikesley.org/projects/marvel-explorer/'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = 'marvel_explorer'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ultron', '~> 0.2'
+  spec.add_dependency 'twitter', '~> 5.13'
+  spec.add_dependency 'dotenv', '~> 0.11'
+  spec.add_dependency 'git', '~> 1.2'
+  spec.add_dependency 'thor', '~> 0.19m '
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.4'
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.20'
+  spec.add_development_dependency 'timecop', '~> 0.7'
+end