ruby-tapas-downloader 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead20e84b9acad5174d882fd8df88d0500ed9ea6
-  data.tar.gz: 575b76bd539f6bf27f80fda9b9640ba890db4bc4
+  metadata.gz: 6f73d2efc12fc1b97b7788fb830e14c2e6039ce6
+  data.tar.gz: 6583cadf3527bf50d55656a64cacbd403309c506
 SHA512:
-  metadata.gz: 82921b9f4ec176dfdd797212b711c1466c17fbfc4d5f9f47d8f73495e6a43fdec71fba4a98ab11a396f460b3179d1a60dbba36ddae345f965d93816e8271b71d
-  data.tar.gz: 955b4d6aaeff3c24251281d25a693c88b214d85e79fb1efdc630047d5624858992a39228391f2015cdf9d3ae43c3eb6e334df872abbeeb88624ff89f635d708f
+  metadata.gz: a770516065e32bbd887947207a26b955bd1d1370a8fa421587744fb4fe7f38e8cb9c62f2df96b712582d5a5e5b3378c5172d9fcf74e06b21d2804c76c3434894
+  data.tar.gz: a33fe0b0674ff9d3d51bc3107d88667fa2ddcd772dd6f54544f97e736f26b56544c5a4f44470204bf124e5d6c85f149880b104c362d859876afb1edd7675f7d1

data/README.md

@@ -23,7 +23,24 @@ Usage
 -----
 
 ```bash
-$ ruby-tapas-downloader <email> <password> <download-path>
+$ ruby-tapas-downloader download -e <email> -p <password> -d <download_path>
+```
+
+If you prefer, you can pre-configure, in that way you dont need authenticate
+every download.
+
+```bash
+$ ruby-tapas-downloader configure -e <email> -p <password> -d <download_path>
+```
+
+One other alternative is to pass/export env vars:
+
+```bash
+$ export RUBY_TAPAS_DOWNLOADER_EMAIL=someone@example.com
+$ export RUBY_TAPAS_DOWNLOADER_PASSWORD=123
+$ export RUBY_TAPAS_DOWNLOADER_DOWNLOAD_PATH=.
+
+$ ruby-tapas-downloader download
 ```
 
 Warning

data/bin/ruby-tapas-downloader

@@ -1,12 +1,5 @@
 #!/usr/bin/env ruby
 
-if ARGV.count != 3
-  abort <<-USAGE
-Usage:
-$ ruby-tapas-downloader <email> <password> <download-path>
-  USAGE
-end
-
 require_relative '../lib/ruby_tapas_downloader/cli'
 
-RubyTapasDownloader::CLI.new(*ARGV).download
+RubyTapasDownloader::CLI.start

data/lib/ruby_tapas_downloader/cli.rb

@@ -1,45 +1,96 @@
+require 'thor'
+require 'user-configurations'
+
 require_relative '../ruby-tapas-downloader'
 
 # The Command Line Interface for Ruby Tapas Downloader.
-class RubyTapasDownloader::CLI
-  # @param email [String] the e-mail for the user.
-  # @param password [String] the password for the user.
-  # @param download_path [String] the path in which the download is performed.
-  def initialize email, password, download_path
-    @email         = email
-    @password      = password
-    @download_path = download_path
-  end
+module RubyTapasDownloader
+  class CLI < Thor
+    # Long description for download action
+    def self.download_long_description
+      env_vars = RubyTapasDownloader::Config::CONFIG_KEYS.join(',')
+      <<-LONG_DESC
+To download you need to be authenticated, you have tree options:
 
-  # Perform complete download procedure.
-  def download
-    create_agent
-    login
-    fetch_feed
-    create_catalog
-    download_catalog
-  end
+- Pass the params described before
 
-  private
+- Use `ruby-tapas-downloader configure`
 
-  def create_agent
-    @agent = Mechanize.new
-  end
+- Pass/export env vars: #{ env_vars }
+      LONG_DESC
+    end
 
-  def login
-    RubyTapasDownloader::Login.new(@agent, @email, @password).login
-  end
+    # Perform complete download procedure.
+    desc 'download', 'Download new content'
+    option(
+      :email, required: true, default: Config.default_email, aliases: '-e'
+    )
+    option(
+      :password,
+      required: true,
+      default: Config.default_password,
+      aliases: '-p'
+    )
+    option(
+      :download_path,
+      required: true,
+      default: Config.default_download_path,
+      aliases: '-d'
+    )
+    long_desc download_long_description
+    def download
+      create_agent
+      login
+      fetch_feed
+      create_catalog
+      download_catalog
+    end
 
-  def fetch_feed
-    @feed = RubyTapasDownloader::FeedFetcher.new(@agent, @email, @password)
-                                                                         .fetch
-  end
+    # Configure user preferences
+    desc 'configure -e foo@bar.com -p 123 -l .', 'Configure user preferences'
+    option :email,         required: true, aliases: '-e'
+    option :password,      required: true, aliases: '-p'
+    option :download_path, required: true, aliases: '-d'
+    def configure
+      RubyTapasDownloader::Config.update(
+        email: email, password: password, download_path: download_path
+      )
+    end
 
-  def create_catalog
-    @catalog = RubyTapasDownloader::Extractors::Catalog.new.extract @feed
-  end
+    private
+
+    def email
+      options[:email]
+    end
+
+    def password
+      options[:password]
+    end
+
+    def download_path
+      options[:download_path]
+    end
+
+    def create_agent
+      @agent = Mechanize.new
+    end
+
+    def login
+      RubyTapasDownloader::Login.new(agent, email, password).login
+    end
+
+    def fetch_feed
+      @feed = RubyTapasDownloader::FeedFetcher.new(agent, email, password).fetch
+    end
+
+    def create_catalog
+      @catalog = RubyTapasDownloader::Extractors::Catalog.new.extract feed
+    end
+
+    def download_catalog
+      @catalog.download path, agent
+    end
 
-  def download_catalog
-    @catalog.download @download_path, @agent
+    attr_accessor :agent, :feed
   end
 end

data/lib/ruby_tapas_downloader/config.rb

@@ -1,14 +1,65 @@
+require 'user-configurations'
+
 # Retrieve configurations.
 class RubyTapasDownloader::Config
+  CONFIG_KEYS = [
+    EMAIL         = 'RUBY_TAPAS_DOWNLOADER_EMAIL',
+    PASSWORD      = 'RUBY_TAPAS_DOWNLOADER_PASSWORD',
+    DOWNLOAD_PATH = 'RUBY_TAPAS_DOWNLOADER_DOWNLOAD_PATH'
+  ]
+
   class << self
+
     # Retrieve urls stored in `urls.yml`.
     # @return [Hash] the urls stored in `urls.yml`.
     def urls
       @urls ||= YAML.load_file urls_config_path
     end
 
+    # Default Email
+    def default_email
+      user_configurations[EMAIL]
+    end
+
+    # Default Password
+    def default_password
+      user_configurations[PASSWORD]
+    end
+
+    # Default Download path
+    def default_download_path
+      user_configurations[DOWNLOAD_PATH]
+    end
+
+    # Updates user preferences
+    def update(email: nil, password: nil, download_path: nil)
+      download_path = absolute_path(download_path)
+
+      new_configs = {
+        EMAIL => email, PASSWORD => password, DOWNLOAD_PATH => download_path
+      }
+
+      user_configurations[EMAIL]         = email
+      user_configurations[PASSWORD]      = password
+      user_configurations[DOWNLOAD_PATH] = download_path
+
+      user_configurations.store new_configs
+    end
+
     private
 
+    def user_configurations
+      @configs ||= UserConfigurations::Configuration.new(
+        'ruby-tapas-downloader'
+      )
+    end
+
+    def absolute_path(path)
+      return path if (Pathname.new path).absolute?
+
+      File.expand_path(Dir.pwd, path)
+    end
+
     def urls_config_path
       Pathname File.expand_path('../../../config/urls.yml', __FILE__)
     end

data/lib/ruby_tapas_downloader/version.rb

@@ -1,3 +1,3 @@
 module RubyTapasDownloader
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,55 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: ruby-tapas-downloader
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Leandro Facchinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: user-configurations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 description: It downloads all episodes and attachments, organizes them for later use
@@ -91,18 +119,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Downloader for Avdi Grimm Ruby Tapas
 test_files: []
+has_rdoc: