rviki 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,6 @@
-== 2012-04-10 14:00:00 +0000 Nia M <nia@viki.com>
+== 2012-04-17 14:00:00 +0000 Nia M <nmutiara@gmail.com>
+
+* Wrap API V2 with RViki::Client
+* Created printer class to format server response output
+* Wrap API V2 with command line interface
 
-* Created rviki

data/README.md

@@ -1,4 +1,4 @@
-# RViki readme
+# RViki 0.0.1 readme
 
 
 RViki is a Ruby client gem for Viki.com API.
@@ -24,7 +24,7 @@ RViki is a Ruby client gem for Viki.com API.
 
 Clipboard output is only for Mac, for now.
 
-### Woot! Command Line!
+### Command Line
 
     $ rviki shows
     $ rviki shows_item 50
@@ -32,3 +32,4 @@ Clipboard output is only for Mac, for now.
     $ rviki shows -f pretty_json 50
     $ rviki shows -o clipboard,stdout 50
 
+

data/Rakefile

@@ -32,5 +32,5 @@ task :build do
 end
 
 task :release => :build do
-  system "gem push rviki-#{RViki::VERSION::STRING}"
+  system "gem push rviki-#{RViki::VERSION::STRING}.gem"
 end

data/bin/{rviki → rviki1}

@@ -6,7 +6,7 @@ begin
   $:.unshift File.expand_path("../lib", bin_file)
 
   require "rviki/cli"
-  cli = RViki::Cli.new
+  cli = RViki::Cli1.new
   cli.execute(*ARGV)
 rescue Interrupt
   `stty icanon echo`

data/bin/rviki2

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+begin
+  require "pathname"
+  bin_file = Pathname.new(__FILE__).realpath
+  $:.unshift File.expand_path("../lib", bin_file)
+
+  require "rviki/cli"
+  cli = RViki::Cli2.new
+  cli.execute(*ARGV)
+rescue Interrupt
+  `stty icanon echo`
+  puts("\n !    Command cancelled.")
+end
+

data/bin/rviki3

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+begin
+  require "pathname"
+  bin_file = Pathname.new(__FILE__).realpath
+  $:.unshift File.expand_path("../lib", bin_file)
+
+  require "rviki/cli"
+  cli = RViki::Cli3.new
+  cli.execute(*ARGV)
+rescue Interrupt
+  `stty icanon echo`
+  puts("\n !    Command cancelled.")
+end
+

data/lib/VERSION

@@ -1,4 +1,4 @@
 major:0
 minor:0
-patch:1
+patch:2
 build:

data/lib/rviki/cli.rb

@@ -2,27 +2,48 @@
 
 require 'optparse'
 require 'rviki'
+require 'rviki/registrable'
 
 module RViki
-  module Registrable
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
+  class Cli1
+    include Registrable
 
-    module ClassMethods
-      def register_command(command_sym, args)
-        registered_commands[command_sym] = args
-      end
+    api_version "V1"
+    binary_name "rviki1"
+    examples <<-EOE
+    $ #{binary_name} shows -o clipboard
+    $ #{binary_name} shows_item 50
+    $ #{binary_name} shows_item 50 es
+    $ #{binary_name} shows -f pretty_json 50
+    $ #{binary_name} shows -o clipboard,stdout 50
+EOE
 
-      def registered_commands
-        @registered_commands ||= {}
-      end
+    def initialize
+      @client  = RViki::ClientV1.new
     end
+
+    register_command :shows, [:language_code]
+    register_command :shows_item, [:id, :language_code]
   end
 
-  class Cli
+  class Cli2
     include Registrable
 
+    api_version "V2"
+    binary_name "rviki2"
+    examples <<-EOE
+    $ #{binary_name} featured
+    $ #{binary_name} shows -o clipboard
+    $ #{binary_name} shows_item 50
+    $ #{binary_name} shows_item 50 es
+    $ #{binary_name} shows -f pretty_json 50
+    $ #{binary_name} shows -o clipboard,stdout 50
+EOE
+
+    def initialize
+      @client  = RViki::ClientV2.new
+    end
+
     register_command :shows, [:language_code]
     register_command :shows_item, [:id, :language_code]
     register_command :featured, []
@@ -38,101 +59,21 @@ module RViki
     register_command :video_casts, [:id]
     register_command :video_parts, [:id]
     register_command :video_posts, [:id]
+  end
 
-    def initialize
-      @client  = RViki::Client.new
-      @printer = RViki::Printer.new([:stdout])
-
-      @print_opts_parser = OptionParser.new do |pop|
-        pop.banner = "Print Options:"
-        pop.on("-f", "--format FORMAT", [:tabular, :pretty_json, :pretty_ruby],
-               "Print with FORMAT (tabular (only for array), pretty_json, or pretty_ruby)") do |pf|
-          printer.format = pf
-        end
-
-        pop.on("-o", "--output clipboard,stdout", Array,
-               "Output to OUTPUT_TARGET (clipboard, stdout)") do |o|
-          o = o.map(&:to_sym)
-          if (o.include?(:clipboard) || o.include?(:stdout))
-            printer.targets = o
-          end
-        end
-      end
-    end
-
-    def execute(*args)
-      @cmd = args.shift
-      @cmd = @cmd.to_sym if @cmd
-      unless valid_command?
-        puts <<-EOL
-
-Command not found: #{@cmd}
-----------------------------------------
-
-RViki Version #{RViki::VERSION::STRING} for Viki API V2
-Usage: rviki <api_endpoint> [--opt optvalue] [api_param1] [api_param2]
-
-Available API Endpoints:
-#{commands_listing}
-#{print_opts_parser}
-
-Examples:
-
-    $ rviki featured
-    $ rviki shows -o clipboard
-    $ rviki shows_item 50
-    $ rviki shows_item 50 es
-    $ rviki shows -f pretty_json 50
-    $ rviki shows -o clipboard,stdout 50
-
-EOL
-        exit(1)
-      end
-
-      @cmd_args = self.class.registered_commands[@cmd]
-      extract_options args
-      response = client.send(@cmd, client_options_hash)
-      printer.object = response.parsed_response
-      printer.do_print
-    end
-
-    protected
-
-    attr_reader :client, :printer, :client_options, :print_opts_parser
-
-    def commands_listing
-      result = ""
-      self.class.registered_commands.each do |endpoint, params|
-        result += "    #{endpoint}"
-        result += "\n        params: #{params.map{|pr| "[:#{pr}]"}.join(' ')}" if params && !params.empty?
-        result += "\n"
-      end
-      result
-    end
+  class Cli3
+    include Registrable
 
-    def extract_options(args)
-      client_opts_i = 0
-      args.each_with_index do |a, i|
-        client_opts_i += 2 if a.start_with?("-")
-      end
+    api_version "V3"
+    binary_name "rviki3"
+    examples <<-EOE
+EOE
 
-      @printer_options = args[0...client_opts_i]
-      print_opts_parser.parse! @printer_options
-      @client_options = args[client_opts_i..-1]
-      true
-    end
-
-    def client_options_hash
-      options = {}
-      client_options.each_with_index do |a, i|
-        options[@cmd_args[i]] = a
-      end
-      options
+    def initialize
+      @client  = RViki::ClientV3.new
     end
 
-    def valid_command?
-      @cmd && !@cmd.empty? && self.class.registered_commands.has_key?(@cmd)
-    end
+    register_command :custom, [:hash]
   end
 end
 

data/lib/rviki/client.rb

@@ -1,6 +1,17 @@
 # encoding: utf-8
 module RViki
-  class Client
+  class ClientV1
+    include Routable
+
+    base_uri 'http://www.viki.com/api/v1'
+    headers "Content-Type" => "application/json", "User-Agent" => "VikiMobile/4.0 RViki::Client"
+    format :json
+
+    route_get "/shows.json", as: :shows
+    route_get "/shows/:id.json", as: :shows_item
+  end
+
+  class ClientV2
     include Routable
 
     base_uri 'http://www.viki.com/api/v2'
@@ -23,5 +34,17 @@ module RViki
     route_get "/videos/:id/parts.json", as: :video_parts
     route_get "/videos/:id/recommended.json", as: :video_posts
   end
+
+  class ClientV3
+    include Routable
+
+    base_uri 'http://www.viki.com/api/v3'
+    headers "Content-Type" => "application/json", "User-Agent" => "VikiMobile/4.0 RViki::Client"
+    format :json
+
+    route_get "/custom.json", as: :custom
+  end
+
+  Client = ClientV2
 end
 

data/lib/rviki/registrable.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+module Registrable
+  def self.included(base)
+    base.send :extend, ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  module ClassMethods
+    def register_command(command_sym, args)
+      registered_commands[command_sym] = args
+    end
+
+    def registered_commands
+      @registered_commands ||= {}
+    end
+
+    def api_version(version=nil)
+      if version.is_a?(String)
+        @api_version = version
+      end
+      @api_version
+    end
+
+    def binary_name(name=nil)
+      if name.is_a?(String)
+        @binary_name = name
+      end
+      @binary_name
+    end
+
+    def examples(ex=nil)
+      if ex.is_a?(String)
+        @examples = ex
+      end
+      @examples
+    end
+  end
+
+  module InstanceMethods
+    def prepare_printer
+      @printer = RViki::Printer.new([:stdout])
+
+      @print_opts_parser = OptionParser.new do |pop|
+        pop.banner = "Print Options:"
+        pop.on("-f", "--format FORMAT", [:tabular, :pretty_json, :pretty_ruby],
+               "Print with FORMAT (tabular (only for array), pretty_json, or pretty_ruby)") do |pf|
+          printer.format = pf
+        end
+
+        pop.on("-o", "--output clipboard,stdout", Array,
+               "Output to OUTPUT_TARGET (clipboard, stdout)") do |o|
+          o = o.map(&:to_sym)
+          if (o.include?(:clipboard) || o.include?(:stdout))
+            printer.targets = o
+          end
+        end
+      end
+    end
+
+    def execute(*args)
+      prepare_printer
+
+      @cmd = args.shift
+      @cmd = @cmd.to_sym if @cmd
+      unless valid_command?
+        puts <<-EOL
+
+Command not found: #{@cmd}
+----------------------------------------
+
+RViki Version #{RViki::VERSION::STRING} for Viki API #{self.class.api_version}
+Usage: #{self.class.binary_name} <api_endpoint> [--opt optvalue] [api_param1] [api_param2]
+
+Available API Endpoints:
+#{commands_listing}
+#{print_opts_parser}
+
+Examples:
+
+#{self.class.examples}
+
+EOL
+        exit(1)
+      end
+
+      @cmd_args = self.class.registered_commands[@cmd]
+      extract_options args
+      response = client.send(@cmd, client_options_hash)
+      printer.object = response.parsed_response
+      printer.do_print
+    end
+
+    protected
+
+    attr_reader :client, :printer, :client_options, :print_opts_parser
+
+    def commands_listing
+      result = ""
+      self.class.registered_commands.each do |endpoint, params|
+        result += "    #{endpoint}"
+        result += "\n        params: #{params.map{|pr| "[:#{pr}]"}.join(' ')}" if params && !params.empty?
+        result += "\n"
+      end
+      result
+    end
+
+    def extract_options(args)
+      client_opts_i = 0
+      args.each_with_index do |a, i|
+        client_opts_i += 2 if a.start_with?("-")
+      end
+
+      @printer_options = args[0...client_opts_i]
+      print_opts_parser.parse! @printer_options
+      @client_options = args[client_opts_i..-1]
+      true
+    end
+
+    def client_options_hash
+      options = {}
+      client_options.each_with_index do |a, i|
+        options[@cmd_args[i]] = a
+      end
+      options
+    end
+
+    def valid_command?
+      @cmd && !@cmd.empty? && self.class.registered_commands.has_key?(@cmd)
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rviki
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70117459607260 !ruby/object:Gem::Requirement
+  requirement: &70201890822080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70117459607260
+  version_requirements: *70201890822080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70117459605860 !ruby/object:Gem::Requirement
+  requirement: &70201890821540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.5.1
   type: :development
   prerelease: false
-  version_requirements: *70117459605860
+  version_requirements: *70201890821540
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70117459605200 !ruby/object:Gem::Requirement
+  requirement: &70201890821040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 4.5.0
   type: :development
   prerelease: false
-  version_requirements: *70117459605200
+  version_requirements: *70201890821040
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70117459604300 !ruby/object:Gem::Requirement
+  requirement: &70201890820540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70117459604300
+  version_requirements: *70201890820540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70117459602640 !ruby/object:Gem::Requirement
+  requirement: &70201890820040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,12 +65,14 @@ dependencies:
         version: 1.0.12
   type: :development
   prerelease: false
-  version_requirements: *70117459602640
+  version_requirements: *70201890820040
 description: A short description
 email:
 - nia@viki.com
 executables:
-- rviki
+- rviki1
+- rviki2
+- rviki3
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -81,12 +83,15 @@ files:
 - lib/rviki/cli.rb
 - lib/rviki/client.rb
 - lib/rviki/printer.rb
+- lib/rviki/registrable.rb
 - lib/rviki/routable.rb
 - lib/rviki/version.rb
 - lib/rviki.rb
 - lib/VERSION
 - CHANGELOG
-- bin/rviki
+- bin/rviki1
+- bin/rviki2
+- bin/rviki3
 homepage: ''
 licenses:
 - ''
@@ -100,6 +105,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2437546894109681493
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: