RTop 0.0.1 → 0.0.2

data/README.md

@@ -18,9 +18,48 @@ Or install it yourself as:
 
 ## Usage
 
-rtop = RTop::RTop.new(File.join('config', 'taobao.yml'))
-item = rtop.get_item(1500022659003)
-puts item["title"]
+### Use in irb
+1. check rtop version in terminal:
+
+    > rtop -v
+
+2. generate rtop configuration file:
+
+    > rtop generate
+   
+3. go into irb, and type:
+
+```ruby
+    > rtop = RTop::RTop.new() # by default will use taobao.yml in current folder or ./config folder
+    > item = rtop.get_item(1500022659003) # default to sandbox mode, so this item is from http://mini.tbsandbox.com/buyer/items_result.htm
+    > puts item["title"]
+```
+
+### Use with rails app
+Simply put configuration file to yourApp/config/ folder, and start to use:
+
+    rtop = RTop::RTop.new()
+    rtop...
+
+### Sample of the configuration file
+
+		defaults: &DEFAULTS
+		  app_key: test
+		  secret_key: test
+		
+		development:
+		  <<: *DEFAULTS
+		  env: development # will use sandbox api url
+		
+		test:
+		  <<: *DEFAULTS
+		  env: test # will use sandbox api url
+		
+		production:
+		  <<: *DEFAULTS
+		  env: production # will use production api url
+		  app_key: 1122334455
+		  secret_key: 23424242424234234242423423
 
 ## Contributing
 

data/README.rdoc

@@ -0,0 +1,3 @@
+= Rtop
+
+This project rocks and uses MIT-LICENSE.

data/Thorfile

@@ -1,11 +1,11 @@
 require 'thor'
-require './lib/rtop/generators/config'
+require 'rtop/generators/config'
 
 module RTop
   class Cli < Thor
     desc "rspec", "Run RSpec Testing"
     def rspec
-      exec "rspec --color --format=documentation spec"
+      exec "rspec ./config --color --format=documentation spec"
     end
   end
 end

data/bin/rtop

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'rtop/runner'
+
+RTop::Runner.start

data/lib/RTop/generators/config.rb

@@ -1,12 +1,29 @@
 require 'thor/group'
+require 'fileutils'
 
 module RTop
   module Generators
     class Config < Thor::Group
       include Thor::Actions
       
+      argument :path, :type => :string, :optional => true
+      
       def copy_config
-        template "taobao.yml", File.join('config', 'taobao.yml')
+        file_path = path
+        unless file_path
+          file_path = File.join(Dir.pwd, 'config')
+          if File.directory?(file_path)
+            say("Seems like there is a /config folder, do you want rtop to generate configuration file to this folder?")
+            y = ask("Yes to generate to /config folder, others to generate to current folder. (Y|N): ")
+            unless "Y".casecmp(y) == 0
+              file_path = Dir.pwd
+            end
+          else
+            file_path = Dir.pwd
+          end
+        end
+        
+        template "taobao.yml", File.join(file_path, 'taobao.yml')
       end
       
       def self.source_root

data/lib/RTop/rtop.rb

@@ -4,6 +4,7 @@ require "base64"
 require "uri"
 require 'httparty'
 require "yaml"
+require 'fileutils'
 
 module RTop
   class RTop
@@ -15,7 +16,18 @@ module RTop
     API_OPTION = { "format" => "json", "v" => "2.0", "sign_method" => "md5" }
     
     def initialize(config_file = nil)
-      config_file ||= "#{Rails.root}/config/taobao.yml"
+      unless config_file
+        if defined? Rails
+          config_file = "#{Rails.root}/config/taobao.yml"
+        else
+          config_file = File.join(Dir.pwd, 'config/taobao.yml')
+          unless File.file?(config_file)
+            config_file = File.join(Dir.pwd, 'taobao.yml')
+          end
+        end
+        raise "taobao.yml not found, generate one with 'rtop generate [path]'." unless File.file?(config_file)
+      end
+      
       @settings = YAML.load_file(config_file)
       @settings = (defined? Rails) ? @settings[Rails.env] : @settings["defaults"]
     end

data/lib/RTop/runner.rb

@@ -0,0 +1,19 @@
+require 'thor'
+require 'rtop/version'
+require 'rtop/generators/config.rb'
+
+class RTop::Runner < Thor
+    map "-v" => :version
+  
+    desc "version", "Show RTop version"
+    def version      
+      say "RTop #{RTop::VERSION}"
+    end
+    
+    desc "generate", "Generate configuration file for rtop"
+    method_options :path => :string, :optional => true
+    def generate
+      RTop::Generators::Config.start([options[:path]])
+    end
+
+end

data/lib/RTop/version.rb

@@ -1,3 +1,3 @@
 module RTop
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/rtop_spec.rb

@@ -1,17 +1,21 @@
 require 'rtop'
 require 'rtop/generators/config'
+require 'rtop/runner'
 
 describe RTop::RTop do
   
+  it "version test" do
+    RTop::Runner.start(["-v"])
+  end
+  
+  it "generate test" do
+    RTop::Runner.start(["generate"])
+  end
+  
   it "get taobao item information" do
     item = RTop::RTop.new(File.join('config', 'taobao.yml')).get_item(1500022659003)
     item.should_not equal(nil)
     item["title"].should_not equal(nil)
   end
-  
-  
-  it "generate the taobao configuration file taobao.yml" do
-    RTop::Generators::Config.start()
-  end
 
 end

data/taobao.yml

@@ -0,0 +1,17 @@
+defaults: &DEFAULTS
+  app_key: test
+  secret_key: test
+
+development:
+  <<: *DEFAULTS
+  env: development # will use sandbox api url
+
+test:
+  <<: *DEFAULTS
+  env: test # will use sandbox api url
+
+production:
+  <<: *DEFAULTS
+  env: production # will use production api url
+  app_key: 1122334455
+  secret_key: 23424242424234234242423423

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RTop
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,7 +62,8 @@ dependencies:
 description: ! 'Library for Taobao Open API '
 email:
 - mingliangfeng@gmail.com
-executables: []
+executables:
+- rtop
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,16 +72,20 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- README.rdoc
 - RTop.gemspec
 - Rakefile
 - Thorfile
+- bin/rtop
 - config/taobao.yml
 - lib/RTop/generators/config.rb
 - lib/RTop/generators/taobao.yml
 - lib/RTop/rtop.rb
+- lib/RTop/runner.rb
 - lib/RTop/version.rb
 - lib/rtop.rb
 - spec/rtop_spec.rb
+- taobao.yml
 homepage: ''
 licenses: []
 post_install_message: