RubyGems - vermic - Versions diffs - 0.1.3 - Mend

vermic 0.1.3

Files changed (15) hide show

data/.gitignore ADDED

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile ADDED

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

data/README.md ADDED

@@ -0,0 +1,30 @@
+Vermic
+======
+Command line utility for publishing your code on pastebin.com
+Current version - 0.1.2
+I often ask questions on irc and forums. So, I had to paste my code into public accessible places such as pastebin.com. This process was pretty much boring - you go to the text editor, you copy everything, you go to the website, you paste it.
+I've decided to create a little utility to make this process easier.
+Now it copies the url of the paste to the system clipboard using the clipboard gem.
+As soon as this is my first gem please let me know if you notice some ugly code or architecture.
+TODO:
+1. + Handle missing mandatory arguments
+2. + Copy URL to the system clipboard(tested for linux only)
+3. Add file extension recognizer
+Why?
+----
+This gem is quite useless because it cannot be used by many people since there's a restriction for pastes from one developer API a day. However, even from this simple project I've learned a lot of things and this is the first gem I've ever created, yupi.
+I feel that there're tons of design and other trivial errors here so if you can admit any mistakes here please let me know.
+Why vermic?
+-----------
+Well, we all know about spaghetti code. Let me give you my association row:
+pastebin.com -> a lot of code -> huh, a lot of spaghetti code -> Italian cuisine -> vermicelli??? -> vermic

data/Rakefile ADDED

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "spec/*_spec.rb"
+end

data/bin/vermic ADDED

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/vermic'

data/lib/vermic.rb ADDED

@@ -0,0 +1,63 @@
+require 'optparse'
+require 'clipboard'
+require_relative "vermic/version"
+require_relative "vermic/pastebin"
+require_relative "vermic/validator"
+# This module parses command line options
+# for vermic command line utility.
+#
+module Vermic
+  options = Hash.new
+  parser = OptionParser.new do |opts|
+    opts.banner = "This is command line utility which pastes your code on pastebin"
+    opts.on("-v", "--version", "shows the current version") do |v|
+      puts Vermic::VERSION
+      exit
+    end
+    opts.on("-n", "--name N", "sets the name of the paste") do |n|
+      options[:paste_name] = name
+    end
+    opts.on("-f", "--format F", "sets the format of the paste") do |format|
+      options[:paste_format] = format
+    end
+    opts.on("-p", "--private", "makes the paste private(public is default)") do |private|
+      options[:paste_private] = 1
+    end
+    opts.on("-e", "--expire E", "sets the expire date of the paste") do |expire_date|
+      options[:paste_expire_date] = expire_date
+    end
+  end
+  begin parser.parse!
+  rescue OptionParser::InvalidOption
+    puts "Invalid option, see --help for list of options"
+    exit
+  rescue OptionParser::MissingArgument => e
+    puts e
+    exit
+  end
+  options[:file_name] = ARGV[0]
+  Validator::validate_options(options)
+  if Validator::any_errors?
+    Validator::print_errors
+  else
+    result = PastebinWrapper::paste_file(options)
+    puts result
+    if result =~ /^https?:\/\//
+      Clipboard::copy(result)
+      puts "This URL has been copied to your clipboard"
+    end
+  end
+end

data/lib/vermic/pastebin.rb ADDED

@@ -0,0 +1,70 @@
+require 'net/http'
+require 'uri'
+# This module works with pastebin.com API.
+#
+module PastebinWrapper
+  POST_URL = "http://pastebin.com/api/api_post.php"
+  API_DEV_KEY = "7fe7c0c1814042eb9f0288d93d954fe9"
+  API_OPTION = 'paste'
+  PASTE_NAME = 'Vermicelli code'
+  PASTE_FORMAT = 'c'
+  PASTE_PRIVATE = 0
+  PASTE_EXPIRE_DATE = '1H'
+  # Pastes plain code to the pastebin.com with
+  # the given parameters
+  #
+  def self.paste_code(code, params = {})
+    initialize_parameters(code)
+    @@params.merge(params)
+    paste
+  end
+  # Pastes file to the pastebin.com site with the
+  # given parameters
+  #
+  def self.paste_file(params = {})
+    code = ""
+    filename = params[:file_name]
+    File.foreach(filename) do |line|
+      code += line
+    end
+    initialize_parameters(code)
+    @@params.merge!(params)
+    paste
+  end
+  # Private helper methods for the Pastebin module
+  private
+  # Pastes the code to the pastebin.com site
+  # with the given parameters and returns either
+  # the link to the pasted code in case of a
+  # successful paste or error message which starts
+  # by "Bad API request..."
+  #
+  def self.paste
+    Net::HTTP.post_form(URI.parse(POST_URL),
+                        {'api_dev_key' => API_DEV_KEY,
+                         'api_option' => API_OPTION,
+                         'api_paste_code' => @@params[:paste_code],
+                         'api_paste_name' => @@params[:paste_name],
+                         'api_paste_format' => @@params[:paste_format],
+                         'api_paste_private' => @@params[:paste_private],
+                         'api_paste_expire_date' => @@params[:paste_expire_date]}).body
+  end
+  # Initializes paste parameters with the default
+  # values except for the paste code which is
+  # passed as a method parameter
+  #
+  def self.initialize_parameters(code)
+    @@params = {paste_name: PASTE_NAME,
+              paste_format: PASTE_FORMAT,
+              paste_private: PASTE_PRIVATE,
+              paste_expire_date: PASTE_EXPIRE_DATE,
+              paste_code: code}
+  end
+end

data/lib/vermic/validator.rb ADDED

@@ -0,0 +1,285 @@
+# This module validates the parameters' values
+# for the correctness
+#
+module Validator
+  # Hash of possible code formats
+  FORMATS_HASH = {
+    "4cs" => "4CS",
+    "6502acme" => "6502 ACME Cross Assembler",
+    "6502kickass" => "6502 Kick Assembler",
+    "6502tasm" => "6502 TASM/64TASS",
+    "abap" => "ABAP",
+    "actionscript" => "ActionScript",
+    "actionscript3" => "ActionScript 3",
+    "ada" => "Ada",
+    "algol68" => "ALGOL 68",
+    "apache" => "Apache Log",
+    "applescript" => "AppleScript",
+    "apt_sources" => "APT Sources",
+    "asm" => "ASM (NASM)",
+    "asp" => "ASP",
+    "autoconf" => "autoconf",
+    "autohotkey" => "Autohotkey",
+    "autoit" => "AutoIt",
+    "avisynth" => "Avisynth",
+    "awk" => "Awk",
+    "bascomavr" => "BASCOM AVR",
+    "bash" => "Bash",
+    "basic4gl" => "Basic4GL",
+    "bibtex" => "BibTeX",
+    "blitzbasic" => "Blitz Basic",
+    "bnf" => "BNF",
+    "boo" => "BOO",
+    "bf" => "BrainFuck",
+    "c" => "C",
+    "c_mac" => "C for Macs",
+    "cil" => "C Intermediate Language",
+    "csharp" => "C#",
+    "cpp" => "C++",
+    "cpp-qt" => "C++ (with QT extensions)",
+    "c_loadrunner" => "C: Loadrunner",
+    "caddcl" => "CAD DCL",
+    "cadlisp" => "CAD Lisp",
+    "cfdg" => "CFDG",
+    "chaiscript" => "ChaiScript",
+    "clojure" => "Clojure",
+    "klonec" => "Clone C",
+    "klonecpp" => "Clone C++",
+    "cmake" => "CMake",
+    "cobol" => "COBOL",
+    "coffeescript" => "CoffeeScript",
+    "cfm" => "ColdFusion",
+    "css" => "CSS",
+    "cuesheet" => "Cuesheet",
+    "d" => "D",
+    "dcs" => "DCS",
+    "delphi" => "Delphi",
+    "oxygene" => "Delphi Prism (Oxygene)",
+    "diff" => "Diff",
+    "div" => "DIV",
+    "dos" => "DOS",
+    "dot" => "DOT",
+    "e" => "E",
+    "ecmascript" => "ECMAScript",
+    "eiffel" => "Eiffel",
+    "email" => "Email",
+    "epc" => "EPC",
+    "erlang" => "Erlang",
+    "fsharp" => "F#",
+    "falcon" => "Falcon",
+    "fo" => "FO Language",
+    "f1" => "Formula One",
+    "fortran" => "Fortran",
+    "freebasic" => "FreeBasic",
+    "freeswitch" => "FreeSWITCH",
+    "gambas" => "GAMBAS",
+    "gml" => "Game Maker",
+    "gdb" => "GDB",
+    "genero" => "Genero",
+    "genie" => "Genie",
+    "gettext" => "GetText",
+    "go" => "Go",
+    "groovy" => "Groovy",
+    "gwbasic" => "GwBasic",
+    "haskell" => "Haskell",
+    "hicest" => "HicEst",
+    "hq9plus" => "HQ9 Plus",
+    "html4strict" => "HTML",
+    "html5" => "HTML 5",
+    "icon" => "Icon",
+    "idl" => "IDL",
+    "ini" => "INI file",
+    "inno" => "Inno Script",
+    "intercal" => "INTERCAL",
+    "io" => "IO",
+    "j" => "J",
+    "java" => "Java",
+    "java5" => "Java 5",
+    "javascript" => "JavaScript",
+    "jquery" => "jQuery",
+    "kixtart" => "KiXtart",
+    "latex" => "Latex",
+    "lb" => "Liberty BASIC",
+    "lsl2" => "Linden Scripting",
+    "lisp" => "Lisp",
+    "llvm" => "LLVM",
+    "locobasic" => "Loco Basic",
+    "logtalk" => "Logtalk",
+    "lolcode" => "LOL Code",
+    "lotusformulas" => "Lotus Formulas",
+    "lotusscript" => "Lotus Script",
+    "lscript" => "LScript",
+    "lua" => "Lua",
+    "m68k" => "M68000 Assembler",
+    "magiksf" => "MagikSF",
+    "make" => "Make",
+    "mapbasic" => "MapBasic",
+    "matlab" => "MatLab",
+    "mirc" => "mIRC",
+    "mmix" => "MIX Assembler",
+    "modula2" => "Modula 2",
+    "modula3" => "Modula 3",
+    "68000devpac" => "Motorola 68000 HiSoft Dev",
+    "mpasm" => "MPASM",
+    "mxml" => "MXML",
+    "mysql" => "MySQL",
+    "newlisp" => "newLISP",
+    "text" => "None",
+    "nsis" => "NullSoft Installer",
+    "oberon2" => "Oberon 2",
+    "objeck" => "Objeck Programming Langua",
+    "objc" => "Objective C",
+    "ocaml-brief" => "OCalm Brief",
+    "ocaml" => "OCaml",
+    "pf" => "OpenBSD PACKET FILTER",
+    "glsl" => "OpenGL Shading",
+    "oobas" => "Openoffice BASIC",
+    "oracle11" => "Oracle 11",
+    "oracle8" => "Oracle 8",
+    "oz" => "Oz",
+    "pascal" => "Pascal",
+    "pawn" => "PAWN",
+    "pcre" => "PCRE",
+    "per" => "Per",
+    "perl" => "Perl",
+    "perl6" => "Perl 6",
+    "php" => "PHP",
+    "php-brief" => "PHP Brief",
+    "pic16" => "Pic 16",
+    "pike" => "Pike",
+    "pixelbender" => "Pixel Bender",
+    "plsql" => "PL/SQL",
+    "postgresql" => "PostgreSQL",
+    "povray" => "POV-Ray",
+    "powershell" => "Power Shell",
+    "powerbuilder" => "PowerBuilder",
+    "proftpd" => "ProFTPd",
+    "progress" => "Progress",
+    "prolog" => "Prolog",
+    "properties" => "Properties",
+    "providex" => "ProvideX",
+    "purebasic" => "PureBasic",
+    "pycon" => "PyCon",
+    "python" => "Python",
+    "q" => "q/kdb+",
+    "qbasic" => "QBasic",
+    "rsplus" => "R",
+    "rails" => "Rails",
+    "rebol" => "REBOL",
+    "reg" => "REG",
+    "robots" => "Robots",
+    "rpmspec" => "RPM Spec",
+    "ruby" => "Ruby",
+    "gnuplot" => "Ruby Gnuplot",
+    "sas" => "SAS",
+    "scala" => "Scala",
+    "scheme" => "Scheme",
+    "scilab" => "Scilab",
+    "sdlbasic" => "SdlBasic",
+    "smalltalk" => "Smalltalk",
+    "smarty" => "Smarty",
+    "sql" => "SQL",
+    "systemverilog" => "SystemVerilog",
+    "tsql" => "T-SQL",
+    "tcl" => "TCL",
+    "teraterm" => "Tera Term",
+    "thinbasic" => "thinBasic",
+    "typoscript" => "TypoScript",
+    "unicon" => "Unicon",
+    "uscript" => "UnrealScript",
+    "vala" => "Vala",
+    "vbnet" => "VB.NET",
+    "verilog" => "VeriLog",
+    "vhdl" => "VHDL",
+    "vim" => "VIM",
+    "visualprolog" => "Visual Pro Log",
+    "vb" => "VisualBasic",
+    "visualfoxpro" => "VisualFoxPro",
+    "whitespace" => "WhiteSpace",
+    "whois" => "WHOIS",
+    "winbatch" => "Winbatch",
+    "xbasic" => "XBasic",
+    "xml" => "XML",
+    "xorg_conf" => "Xorg Config",
+    "xpp" => "XPP",
+    "yaml" => "YAML",
+    "z80" => "Z80 Assembler",
+    "zxbasic" => "ZXBasic"
+  }
+  # Hash of possible expire date values
+  EXPIRE_DATE_HASH = {
+    "N" => "Never",
+    "10M" => "10 Minutes",
+    "1H" => "1 Hour",
+    "1D" => "1 Day",
+    "1M" => "1 Month"
+  }
+  # Validates all the options which exist in the
+  # options array(defined by the user)
+  #
+  def self.validate_options(options = {})
+    @errors = []
+    validate_name(options[:paste_name]) if options.has_key?(:paste_name)
+    validate_format(options[:paste_format]) if options.has_key?(:paste_format)
+    validate_expire_date(options[:paste_expire_date]) if options.has_key?(:paste_expire_date)
+    validate_file(options[:file_name])
+  end
+  # Checks if the options have any errors
+  #
+  def self.any_errors?
+    !@errors.empty?
+  end
+  # Prints all the errors of all options
+  # to the shell
+  #
+  def self.print_errors
+    @errors.each do |e|
+      puts e
+    end
+  end
+  private
+  # Validates the name of the paste
+  #
+  def self.validate_name(name)
+     @errors << "Name can't be empty" if name.empty?
+  end
+  # Validates the format of the paste
+  #
+  def self.validate_format(format)
+    if !FORMATS_HASH.has_key?(format)
+      @errors << "Wrong format"
+      FORMATS_HASH.keys.each do |key|
+        @errors << "\t#{key} -> #{FORMATS_HASH[key]}"
+      end
+    end
+  end
+  # Validates the expire date of the paste
+  #
+  def self.validate_expire_date(expire_date)
+    if !EXPIRE_DATE_HASH.has_key?(expire_date)
+      @errors << "Wrong format of expire date, you should use the following arguments:"
+      EXPIRE_DATE_HASH.keys.each do |key|
+        @errors << "\t#{key.to_s} -> #{EXPIRE_DATE_HASH[key]}"
+      end
+    end
+  end
+  # Validates the file
+  #
+  def self.validate_file(filename)
+    if filename.nil?
+      @errors << "But you didn't provide the file"
+    else
+      @errors << "There's no such file" if !File.exists?(filename)
+    end
+  end
+end

data/lib/vermic/version.rb ADDED

@@ -0,0 +1,3 @@
+module Vermic
+  VERSION = "0.1.3"
+end

data/spec/files/empty_file ADDED

File without changes

data/spec/files/file ADDED

	@@ -0,0 +1,2 @@
1	+ some text here
2	+ this file is not empty

data/spec/pastebin_spec.rb ADDED

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require_relative '../lib/vermic/pastebin'
+# Tests PastebinWrapper module
+#
+describe PastebinWrapper do
+  it "shouldn't post empty code" do
+    # PastebinWrapper::paste_code('').must_match(/Bad API request.*/)
+  end
+  it "should return url when no params" do
+    # PastebinWrapper::paste_code('some code').must_match(/http:\/\/pastebin.com\/\w+/)
+  end
+  it "shouldn't paste empty file" do
+    options = {
+      file_name: File.expand_path('spec/files/empty_file')
+    }
+    # PastebinWrapper::paste_file(options).must_match(/Bad API request.*/)
+  end
+end

data/spec/validator_spec.rb ADDED

@@ -0,0 +1,50 @@
+require 'minitest/autorun'
+require_relative '../lib/vermic/validator'
+# Tests Validator
+#
+describe "Validator" do
+ it "should fail if empty name" do
+  options = {paste_name: "", paste_format: "c", paste_expire_date: "1M"}
+  Validator::validate_options(options)
+  Validator::any_errors?.must_equal(true)
+ end
+ it "should fail if empty format" do
+  options = {paste_name: "Some code", paste_format: "", paste_expire_date: "1H"}
+  Validator::validate_options(options)
+  Validator::any_errors?.must_equal(true)
+ end
+ it "should fail if empty expire date" do
+   options = {paste_name: "Some code", paste_format: "yaml", paste_expire_date: ""}
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+ end
+ it "should fail if wrong format" do
+   options = {paste_name: "Some code", paste_format: "cee", paste_expire_date: "1D"}
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+   options[:paste_name] = "z801"
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+ end
+ it "should fail if wrong expire date" do
+   options = {paste_name: "Some code", paste_format: "vim", paste_expire_date: "10m"}
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+   options[:paste_expire_date] = "n"
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+ end
+ it "should fail if file is not given" do
+   options = {paste_name: "Some code", paste_format: "yaml", paste_expire_date: "10M", file_name: nil}
+   Validator::validate_options(options)
+   Validator::any_errors?.must_equal(true)
+ end
+end

data/vermic.gemspec ADDED

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "vermic/version"
+Gem::Specification.new do |s|
+  s.name        = "vermic"
+  s.version     = Vermic::VERSION
+  s.authors     = ["Sergey Kim"]
+  s.email       = ["skim1776@gmail.com"]
+  s.homepage    = "http://www.github.com/skim1776/vermic"
+  s.summary     = %q{Pastes your code to the pastebin.com}
+  s.description = %q{I often need to paste my code to some place with public access in order to ask questions.
+ This utility makes this process easier.}
+  s.rubyforge_project = "vermic"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+   s.add_runtime_dependency "clipboard"
+end

metadata ADDED

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: vermic
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease:
+platform: ruby
+authors:
+- Sergey Kim
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-02-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: &22159340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22159340
+description: ! "I often need to paste my code to some place with public access in
+  order to ask questions.\n This utility makes this process easier."
+email:
+- skim1776@gmail.com
+executables:
+- vermic
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/vermic
+- lib/vermic.rb
+- lib/vermic/pastebin.rb
+- lib/vermic/validator.rb
+- lib/vermic/version.rb
+- spec/files/empty_file
+- spec/files/file
+- spec/pastebin_spec.rb
+- spec/validator_spec.rb
+- vermic.gemspec
+homepage: http://www.github.com/skim1776/vermic
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: vermic
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: Pastes your code to the pastebin.com
+test_files:
+- spec/files/empty_file
+- spec/files/file
+- spec/pastebin_spec.rb
+- spec/validator_spec.rb