brandeins 0.2.2 → 0.3.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c4cc751ae449333a24d1127535da306b200154
+  data.tar.gz: d2a62acfbdef5f2c7f563edc342579bd156523e2
+SHA512:
+  metadata.gz: 5120d2ceaa37925d19fa43ca96cf8f5709526c5d7cc368cb19ea1e2c5a520de90670cd5d6c81987919b321967199358621b835a8f0e8c8fdb075d70623f5a9ad
+  data.tar.gz: f2a313a749fcd7cebb93822bace5242af17018ae64825e4f1c9d065ec13ec607633138cf6cdff29efe79bbdf3e663c93e985eef53e00d3b47c27ad96a5ee1185

data/.gitignore

@@ -2,5 +2,9 @@
 *.gem
 .bundle
 .vagrant
-pkg/*
+.yardoc
+pkg
 tags
+vendor/ruby
+vendor/bundle
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Includes:
+    - Rakefile
+  Excludes:
+    - vendor/**

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script: "rake spec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+gemfile:
+  - Gemfile
+branches:
+  only:
+    - master

data/Gemfile

@@ -1,12 +1,15 @@
 source "http://rubygems.org"
 
 group :test do
-  if ENV['RUBY_VERSION'][5,3] == '1.8'
-    gem 'minitest'
-  end
+  gem 'rspec'
   gem 'webmock'
-  gem 'debugger'
+  gem 'rubocop'
 end
 
+group :debug do
+  if RUBY_VERSION.split('.').first.to_i > 1
+    gem 'byebug'
+  end
+end
 
 gemspec

data/Gemfile.lock

@@ -1,47 +1,73 @@
 PATH
   remote: .
   specs:
-    brandeins (0.2.2)
+    brandeins (0.3.0.pre)
       nokogiri
       prawn
       rake
-      thor
 
 GEM
   remote: http://rubygems.org/
   specs:
     Ascii85 (1.0.2)
-    addressable (2.3.2)
+    addressable (2.3.5)
+    afm (0.2.0)
+    ast (1.1.0)
+    byebug (2.5.0)
+      columnize (~> 0.3.6)
+      debugger-linecache (~> 1.2.0)
     columnize (0.3.6)
-    crack (0.3.2)
-    debugger (1.3.1)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.1.1)
-      debugger-ruby_core_source (~> 1.1.8)
-    debugger-linecache (1.1.2)
-      debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.8)
-    hashery (2.1.0)
-    nokogiri (1.5.6)
-    pdf-reader (1.2.0)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    hashery (2.1.1)
+    mini_portile (0.5.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    parser (2.0.0)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    pdf-reader (1.3.3)
       Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
       hashery (~> 2.0)
       ruby-rc4
-    prawn (1.0.0.rc1)
-      pdf-reader (>= 0.9.0)
+      ttfunk
+    powerpack (0.0.9)
+    prawn (0.13.0)
+      afm
+      pdf-reader (~> 1.2)
+      ruby-rc4
       ttfunk (~> 1.0.3)
-    rake (10.0.3)
+    rainbow (1.1.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubocop (0.15.0)
+      parser (~> 2.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.1.4)
     ruby-rc4 (0.1.5)
-    thor (0.17.0)
+    safe_yaml (0.9.7)
+    slop (3.4.7)
     ttfunk (1.0.3)
-    webmock (1.9.0)
+    webmock (1.16.1)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   brandeins!
-  debugger
+  byebug
+  rspec
+  rubocop
   webmock

data/NOTES.md

@@ -0,0 +1,6 @@
+# BrandEins Client Design
+ 
+* Usage
+require 'brandeins/client'
+client = BrandEins::Client.new
+

data/Rakefile

@@ -1,18 +1,25 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'rspec/autorun'
 
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/*_test.rb', 'specs/*_spec.rb']
-  t.verbose    = true
+Rubocop::RakeTask.new
+
+Rake::TestTask.new(:spec) do |t|
+  t.pattern = 'spec/lib/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :load_version_file do
+  require_relative './lib/brandeins/version'
 end
 
-task :install do
-  require './lib/brandeins/version'
+task install: [ :load_version_file ] do
+  require_relative './lib/brandeins/version'
   sh "gem install ./pkg/brandeins-#{BrandEins::VERSION}.gem"
 end
 
-task publish: [ :build ] do
-  require './lib/brandeins/version'
+task install: [ :load_version_file, :build ] do
   sh "gem push ./pkg/brandeins-#{BrandEins::VERSION}.gem"
 end
 
@@ -32,4 +39,4 @@ rule /^version:bump:(major|minor|patch)/ do |t|
   sh "git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
 end
 
-task :default => :test
+task default: :spec

data/bin/brandeins

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'brandeins'
-BrandEins::CLI.start
+require 'brandeins/cli'
+
+BrandEins::Cli.run

data/brandeins.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.description = %q{BrandEins gem offers a download command to download a specific or all volumes. Use `brandeins help` to find out more about it}
 
   s.add_dependency "rake"
-  s.add_dependency "thor"
   s.add_dependency "nokogiri"
   s.add_dependency "prawn"
 

data/lib/brandeins.rb

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
-require 'brandeins/version'
-require 'brandeins/errors'
-require 'brandeins/downloader'
-require 'brandeins/setup'
-require 'brandeins/cli'
+require_relative 'brandeins/version'
+require_relative 'brandeins/config'
+require_relative 'brandeins/kiosk'
 
 module BrandEins; end

data/lib/brandeins/cli.rb

@@ -1,47 +1,59 @@
 # encoding: utf-8
-require 'thor'
+
+require 'optparse'
+require 'ostruct'
+require 'singleton'
+
+require_relative '../brandeins'
+require_relative '../brandeins/utils/cli_option_parser'
 
 module BrandEins
-  class CLI < Thor
-    map '--version' => :version
+  class CLI
+    include Singleton
 
-    desc '--version', 'Displays current version'
-    def version
-      puts BrandEins::VERSION
+    def self.run(args)
+      @@args = args
+      instance.run
     end
 
-    desc 'download', 'Download past brand eins magazines (use `brandeins help download` to learn more about options)'
-    method_option :path, :type => :string
-    method_option :volume, :type => :numeric
-    method_option :all
-    method_option :year, :type => :numeric
-    def download
-      path   = options.path ? File.expand_path(options.path) : Dir.pwd
-      year   = options.year || Time.new.year
-      all    = options.all
-      volume = options.volume
-
-      if volume.nil? and all.nil?
-        puts "If you want to download a specific volune use the --volume flag or use --all to download all volumes of a year"
-      else
-        downloader = BrandEins::Downloader.new(path, verbose: true)
-        if !all.nil?
-          downloader.get_magazines_of_year year
-        else
-          downloader.get_magazine year, volume
-        end
+    def initialize(args = ARGV)
+      @args = (@@args || args).dup
+    end
+
+    def run
+      options = BrandEins::CliOptionParser.parse(@args)
+      if options.version
+        puts BrandEins::VERSION
+        return
+      end
+      if options.download
+        path   = options.path
+        month  = options.month
+        year   = options.year
+        errors = validate_options(options)
+        puts errors.join("\n") && return unless error.empty?
+        download(path: path, month: month, yeaR: year)
       end
     end
 
-    desc 'setup', 'Checks if all requirements for using brandeins gem are met'
-    method_option :help
-    def setup
-      setup = BrandEins::Setup.new
-      if !options.help.nil?
-        setup.help
-      else
-        setup.run
+    def download(path: nil, month: nil, year: nil)
+      kiosk = BrandEins::Kiosk.new(path: path)
+      kiosk.fetch_magazine(month: month, year: year)
+    rescue BrandEins::Utils::Fetcher::ContentNotFetchedError => e
+      puts "Download Error: #{e}\n\n"
+      puts "#{e.backtrace.join('\n')}"
+    end
+
+    def validate_options
+      errors = []
+      if !(1..12).include? @options.month
+        errors.push("Invalid month: Must be between 1 and 12")
       end
+      if !(2000..Time.now.year).include? @options.year
+        errors.push("Invalid year: Must be between 2000 and #{Time.now.year}")
+      end
+      return errors
     end
+
   end
 end

data/lib/brandeins/config.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+# Access it like:
+#   BrandEins::Config['base_uri']
+#
+module BrandEins
+  class Config
+    BASE_URI          = 'http://www.brandeins.de'
+    ARCHIVE_URI       = BASE_URI + '/archiv.html'
+    BASE_PATH         = Pathname.new(ENV['HOME']) + '.brandeins'
+    CACHE_PATH        = BASE_PATH + 'cache'
+    TEMP_PATH         = BASE_PATH + 'temp'
+    CACHE_LIMIT_BYTES = 400 * 1024 ** 2
+
+    def self.[](name)
+      const_get(name.upcase)
+    end
+  end
+end

data/lib/brandeins/kiosk.rb

@@ -0,0 +1,100 @@
+require 'pathname'
+require 'fileutils'
+
+require_relative 'config'
+require_relative 'utils/fetcher'
+require_relative 'pages/archive'
+require_relative 'pages/archive'
+require_relative 'pages/cover'
+require_relative 'merger/pdf_tools'
+
+module BrandEins
+  # Usage of
+  class Kiosk
+    attr_reader :target_path
+
+    class InvalidPathError < StandardError; end
+
+    def initialize(opts = {})
+      @target_path = opts.fetch(:path) { Pathname.new('.').realpath.to_s }
+      raise_if_path_inaccessible
+      set_opts_for_cli_output(opts)
+      create_directories_if_necessary
+    end
+
+    def create_directories_if_necessary
+      cache_path.mkpath unless cache_path.exist?
+      temp_path.mkpath unless temp_path.exist?
+    end
+
+    def set_opts_for_cli_output(opts)
+      cli_output_opts = {}
+      cli_output_opts[:debug] = !!opts[:verbose]
+      cli.set_options(cli_output_opts)
+    end
+
+    def raise_if_path_inaccessible
+      path = Pathname.new(@target_path)
+      if !path.writable?
+        raise InvalidPathError, 'Could not access the given path'
+      end
+    end
+
+    def download_magazine(month: nil, year: nil)
+      magazine           = fetch_magazine(month: month, year: year)
+      cover_pdf_path     = download_cover(magazine)
+      article_pdf_paths  = download_article_pdfs(magazine)
+      magazine_pdf_files = article_pdfs.unshift(cover_pdf)
+      merge_pdf_files(magazine_pdf_files)
+    end
+
+    def merge_pdf_files(pdf_files)
+      magazine_file_path = magazine_file_path(month: month, year: year)
+      merger.merge_pdf_files(pdf_files, magazine_file_path)
+      clear_temp_path
+      magazine_file_path
+    end
+
+    def download_article_pdfs(magazine)
+      magazine.save_articles_to(temp_path)
+    end
+
+    def download_cover(magazine)
+      cover = BrandEins::Pages::Cover.new(magazine)
+      cover.save_to(temp_path)
+    end
+
+    def fetch_magazine(month: nil, year: nil)
+      archive.magazine_for(month: month, year: year)
+    end
+
+    def magazine_file_path(month: nil, year: nil)
+      Pathname.new(@target_path) + "brandeins-#{month}-#{year}.pdf"
+    end
+
+    def clear_temp_path
+      FileUtils.rm Dir["#{temp_path}/*.pdf"]
+    end
+
+    def merger
+      @merger ||= BrandEins::Merger::PdfTools.get_pdf_tool
+    end
+
+    def temp_path
+      BrandEins::Config['temp_path']
+    end
+
+    def cache_path
+      BrandEins::Config['cache_path']
+    end
+
+    def archive
+      @archive ||= BrandEins::Pages::Archive.new
+    end
+
+    def cli
+      @cli ||= BrandEins::Utils::CliOutput.instance
+    end
+
+  end
+end