firebrew 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee0908cafa9dc7f91a605e060ed0e023b63cb9a4
+  data.tar.gz: 88e3a156dfba8e25ed0f3dab12e6a6418a6a5f93
+SHA512:
+  metadata.gz: 9258b7043880fe71cf3259f7b4d065694e8936d3a69f88bf63705d2d98cd77223dfdbeb3ca0de5bca35768e605c9e6d0e7562494818d06eab1247839eddb95d3
+  data.tar.gz: 5b7b4e143d90517b87eeb16938b51171356970b91d105f8be5d5f62874ae8caf118c9f7a8cf3dfccf1b841b2f5401669ae67631535617f9610858940a5661e12

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor/bundle

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuichi Murata
+
+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,127 @@
+# Firebrew
+
+Firefox add-ons manager for CUI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firebrew'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebrew
+
+## Usage
+
+The structure of the command line is shown below:
+
+```bash
+$ firebrew [--help] [--version]
+           [--base-dir=<path>] [--profile=<name>] [--firefox=<path>]
+           <command> [<args>]
+```
+
+### commands
+
+#### install
+
+Install the extension which is designated by the `extension-name` argument:
+
+```bash
+$ firebrew install <extension-name>
+```
+
+#### uninstall
+
+Uninstall the extension which is designated by the `extension-name` argument:
+
+```bash
+$ firebrew uninstall <extension-name>
+```
+
+#### info
+
+Show detail information of the extension which is designated by the `extension-name` argument:
+
+```bash
+$ firebrew info <extension-name>
+```
+
+#### search
+
+Enumerate the remote extensions whose name is matched the `term` argument:
+
+```bash
+$ firebrew search <term>
+```
+
+#### list
+
+Enumerate the installed extensions:
+
+```bash
+$ firebrew list
+```
+
+### options
+
+#### --base-dir
+
+The Firefox profiles.ini directory:
+
+```bash
+-d <path>, --base-dir=<path>
+```
+
+The default value is listed below:
+
+| platform | path |
+| -------- | ---- |
+| Mac OS X | ~/Library/Application Support/Firefox | 
+| Linux    | ~/.mozilla/firefox |
+| Windows 7 x86\_64 | %UserProfile%\AppData\Roming\Mozilla\Firefox |
+
+It's able to overridden by the `FIREBREW_FIREFOX_PROFILE_BASE_DIR` environment variable.
+
+#### --profile-name
+
+The Firefox profile name:
+
+```bash
+-p <name>, --profile=<name>
+```
+
+The default value is `default`, and it's able to overridden by the `FIREBREW_FIREFOX_PROFILE` environment variable.
+
+#### --firefox
+
+The Firefox command path:
+
+```bash
+-f <path>, --firefox=<path>
+```
+
+The default value is listed below:
+
+| platform | path |
+| -------- | ---- |
+| Mac OS X | /Applications/Firefox.app/Contents/MacOS/firefox-bin |
+| Linux    | /usr/bin/firefox |
+| Windows 7 x86\_64 | C:\Program Files (x86)\Mozilla Firefox\firefox.exe |
+
+It's able to overridden by the `FIREBREW_FIREFOX` environment variable.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/mrk21/firebrew/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/firebrew

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'firebrew'
+
+Firebrew::CommandLine.execute

data/firebrew.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebrew/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebrew"
+  spec.version       = Firebrew::VERSION
+  spec.authors       = ["Yuichi Murata"]
+  spec.email         = ["mrk21info+rubygems@gmail.com"]
+  spec.summary       = %q{Firefox add-ons manager for CUI.}
+  spec.description   = %q{Firefox add-ons manager for CUI.}
+  spec.homepage      = "https://github.com/mrk21/firebrew"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.add_dependency "activesupport", "~> 4.1"
+  spec.add_dependency "activeresource", "~> 4.0"
+  spec.add_dependency "activemodel", "~> 4.1"
+  spec.add_dependency "inifile", "~> 2.0"
+end

data/lib/firebrew.rb

@@ -0,0 +1,20 @@
+require "firebrew/version"
+
+module Firebrew
+  class Error < StandardError; def status; 1 end end
+  class ProfilesFileNotFoundError < Error; def status; 2 end end
+  class ProfileNotFoundError < Error; def status; 3 end end
+  class ExtensionsFileNotFoundError < Error; def status; 4 end end
+  class ExtensionNotFoundError < Error; def status; 5 end end
+  class FirefoxCommandError < Error; def status; 6 end end
+  class CommandLineError < Error; def status; 7 end end
+  class OperationAlreadyCompletedError < Error; def status; 8 end end
+end
+
+require 'firebrew/entity'
+require 'firebrew/amo_api/search'
+require 'firebrew/firefox/profile'
+require 'firebrew/firefox/extension'
+require 'firebrew/firefox/command'
+require 'firebrew/runner'
+require 'firebrew/command_line'

data/lib/firebrew/amo_api/search.rb

@@ -0,0 +1,50 @@
+require 'active_resource'
+require 'uri'
+require 'firebrew/firefox/basic_extension'
+
+module Firebrew::AmoApi
+  class Search < ActiveResource::Base
+    class Format
+      include ActiveResource::Formats::XmlFormat
+      
+      def decode(xml)
+        results = super(xml)['addon'] || []
+        results.instance_of?(Array) ? results : [results]
+      end
+    end
+    
+    self.site = 'https://services.addons.mozilla.org'
+    self.format = Format.new
+    
+    def self.path(params={})
+      path_source = '/ja/firefox/api/%{api_version}/search/%{term}/%{type}/%{max}/%{os}/%{version}'
+      default_params = {
+        api_version: 1.5,
+        type: 'all',
+        max: 30,
+        os: 'all',
+        version: '',
+      }
+      URI.encode(path_source % default_params.merge(params))
+    end
+    
+    def self.fetch(params={})
+      self.find(:all, from: self.path(params)).to_a
+    end
+    
+    def self.fetch!(params={})
+      results = self.fetch(params)
+      raise Firebrew::ExtensionNotFoundError if results.empty?
+      results
+    end
+    
+    def extension
+      Firebrew::Firefox::BasicExtension.new(
+        name: self.name,
+        guid: self.guid,
+        uri: self.install,
+        version: self.version
+      )
+    end
+  end
+end

data/lib/firebrew/command_line.rb

@@ -0,0 +1,140 @@
+require 'optparse'
+
+module Firebrew
+  class CommandLine
+    attr_accessor :arguments
+    
+    def self.execute
+      begin
+        if block_given? then
+          yield
+        else
+          self.new(ARGV).execute
+        end
+      rescue Firebrew::Error => e
+        $stderr.puts e.message
+        exit e.status
+      rescue SystemExit => e
+        exit 1
+      rescue Exception => e
+        $stderr.puts e.inspect
+        $stderr.puts e.backtrace
+        exit 255
+      else
+        exit 0
+      end
+    end
+    
+    def initialize(args=[])
+      opt = OptionParser.new
+      opt.version = Firebrew::VERSION
+      opt.banner = <<-USAGE.split(/\n/).map{|v| v.gsub(/^(  ){4}/,'')}.join("\n")
+        Usage: firebrew [--help] [--version]
+               [--base-dir=<path>] [--profile=<name>] [--firefox=<path>]
+               <command> [<args>]
+        
+        commands:
+            install:
+                firebrew install <extension-name>
+            
+            uninstall:
+                firebrew uninstall <extension-name>
+            
+            info:
+                firebrew info <extension-name>
+            
+            search:
+                firebrew search <term>
+            
+            list:
+                firebrew list
+        
+        options:
+      USAGE
+      
+      self.arguments = {
+        command: nil,
+        params: {},
+        config: {}
+      }
+      
+      self.register_global_options(opt)
+      self.class.opt_operation(opt, :order!, args)
+      
+      case args.shift
+      when 'install' then
+        self.class.opt_operation(opt, :permute!, args)
+        self.arguments[:command] = :install
+        self.arguments[:params][:term] = args[0]
+        
+      when 'uninstall' then
+        self.class.opt_operation(opt, :permute!, args)
+        self.arguments[:command] = :uninstall
+        self.arguments[:params][:term] = args[0]
+        
+      when 'info' then
+        self.class.opt_operation(opt, :permute!, args)
+        self.arguments[:command] = :info
+        self.arguments[:params][:term] = args[0]
+        
+      when 'search' then
+        self.class.opt_operation(opt, :permute!, args)
+        self.arguments[:command] = :search
+        self.arguments[:params][:term] = args[0]
+        
+      when 'list' then
+        self.class.opt_operation(opt, :permute!, args)
+        self.arguments[:command] = :list
+        
+      when nil then
+        self.class.opt_operation(opt, :permute, ['--help'])
+      
+      else
+        raise Firebrew::CommandLineError
+      end
+    end
+    
+    def execute
+      runner = Runner.new(self.arguments[:config])
+      
+      case self.arguments[:command]
+      when :search, :list then
+        results = runner.send(self.arguments[:command], self.arguments[:params])
+        results.each do |result|
+          puts result.name
+        end
+        
+      when :info then
+        result = runner.send(self.arguments[:command], self.arguments[:params])
+        puts result.to_xml
+        
+      else
+        runner.send(self.arguments[:command], self.arguments[:params])
+      end
+    end
+    
+    protected
+    
+    def self.opt_operation(opt, operation, args)
+      begin
+        opt.send(operation, args)
+      rescue OptionParser::InvalidOption
+        raise Firebrew::CommandLineError
+      end
+    end
+    
+    def register_global_options(opt)
+      opt.on('-d <path>','--base-dir=<path>','Firefox profiles.ini directory') do |v|
+        self.arguments[:config][:base_dir] = v
+      end
+      
+      opt.on('-p <name>','--profile=<name>','Firefox profile name') do |v|
+        self.arguments[:config][:profile] = v
+      end
+      
+      opt.on('-f <path>','--firefox=<path>','Firefox command path') do |v|
+        self.arguments[:config][:firefox] = v
+      end
+    end
+  end
+end