restclient_api_base 0.0.2 → 0.1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0e7611148ac41483a29424a93722a812e6145f8
-  data.tar.gz: 67e70e6fbcfe73146b35638a26a5aaa42bacbb9c
+  metadata.gz: 6cacd3d776f0ba45e963e107941edde906373b84
+  data.tar.gz: f48eb62d02c192c5662ceea2ed2326e816f15c38
 SHA512:
-  metadata.gz: ec04065543d39890702faf28564ade8cf3d8a4dc922af9d4ad20766979897103f35eaa0147b0dc362d0ba09d055b0f579f68a8cf820356f9e2839ec5162e52d4
-  data.tar.gz: 4b655321c95e2796e37ab18a14024821039e8cd0d46213ce649be9811cbf3ec1fe48849e4061a8d2d9acfb84944c7c1b2dd264b6e8f586aa94c2c8d190cbd283
+  metadata.gz: f20b6f55a8de947b06a91d43ddd68f607afd4395397702dc1fe57f5534bdda6692e0b815cae77bfcf37df629c077ab6e1aa33cb1b03a987040d8067f54ecdeff
+  data.tar.gz: 531ee4b36b4cad6028634cf15fcb20fe7f6fc36ab70362e438bf30b388affb287caaed7b0735be63476e39e3e32c4c52102af85f4930a55ef57060a1a2e60b33

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in restclient_api_base.gemspec
+
+gem "rest-client", "~> 1.7"
+gem "lumberjack", "~> 1.0"
+
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # RestclientApiBase
 
-以 REST 方式调用外部 API 的基础类, 默认 Content-Type 为 JSON
+以 REST 方式调用外部 API 的基础类, Content-Type 为 JSON
 
 ## Dependency
 
@@ -8,6 +8,8 @@
 
 [rest-client](https://github.com/rest-client/rest-client)
 
+[lumberjack](https://github.com/bdurand/lumberjack)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,13 +32,22 @@ require 'restclient_api_base'
 module A
   include RestclientApiBase
 
-  self.base_url = 'http://www.example.com'  # define app base url
-  self.private_params = { key: 'api_key' }  # define app secret key
+  self.base_url       = 'http://www.example.com'  # define app base url
+  self.private_params = { key: 'api_key' }        # define app secret key
+  self.logger_name    = 'Error'                   # define error name in log dir
+  self.debug          = true                      # debug
 end
 
-A.get('/api/xxx', key_1: value_1, key_2: value_2)   # => { response: json_response }
-A.post('/api/xxx', key_1: value_1, key_2: value_2)
-A.patch('/api/xxx', key_1: value_1, key_2: value_2)
+res = A.get('/api/xxx', key_1: value_1, key_2: value_2)   # => { response: json_response }
+res.code     # => 200
+res.cookies  # => { 'key' => 'value' }
+res.headers  # => {:content_type=>"text/html; charset=utf-8", :cache_control=>"private" ...
+
+res = A.post('/api/xxx', key_1: value_1, key_2: value_2)
+res = A.patch('/api/xxx', key_1: value_1, key_2: value_2)
+
+write_log(res) # => [2014-08-19T22:10:29.438 INFO (32890)] res..
+
 ```
 
 ## Contributing

data/lib/concern.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module ActiveSupport
   # A typical module looks like this:
   #

data/lib/restclient_api_base/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module RestclientApiBase
-  VERSION = "0.0.2"
+  VERSION = "0.1.1.1"
 end

data/lib/restclient_api_base.rb

@@ -1,12 +1,15 @@
+# encoding: utf-8
+
 require "restclient_api_base/version"
 require "json"
 require "rest-client"
+require "lumberjack"
 
 # For other framework except Rails
 begin
   require "active_support/concern"
 rescue LoadError => e
-  require "./lib/concern"
+  require "concern"
 end
 
 module RestclientApiBase
@@ -15,47 +18,73 @@ module RestclientApiBase
   module ClassMethods
 
     # base_url: the api base url, like: http://api.example.com, default is ''
-    # content_type: dafault is { content_type: :json, accept: :json }
     # private_params: your api secret, like: { app_id: 'xxxx' }, default is {}
 
-    attr_accessor :base_url, :content_type, :private_params
+    attr_accessor :base_url, :private_params, :logger_name, :debug
+
+    def get api_url, options = {}
+      url    = base_url + api_url
+      params = private_params.merge(options)
+
+      puts "method: GET, url: #{url}, params: #{params}" if debug
 
-    def get api_url, params = {}
-      res = RestClient.get(
-        base_url + api_url,
-        params: private_params.merge(params)
-      )
+      begin
+        res = RestClient.get(url, params: params)
+      rescue => e
+        e.response
+      end
     end
 
     def post api_url, query = {}, headers = {}
-      res = RestClient.post(
-        base_url + api_url,
-        JSON.generate(private_params.merge(query)),
-        content_type.merge(headers)
-      )
+      url    = base_url + api_url
+      params = private_params.merge(query)
+
+      puts "method: POST, url: #{url}, params: #{params}" if debug
+
+      begin
+        res = RestClient.post(url, JSON.generate(params), content_type.merge(headers))
+      rescue => e
+        e.response
+      end
     end
 
-    def patch api_url, query = {}
-      res = RestClient.patch(
-        base_url + api_url,
-        JSON.generate(private_params.merge(query)),
-        content_type.merge(headers)
-      )
+    def patch api_url, query = {}, headers = {}
+      url    = base_url + api_url
+      params = private_params.merge(query)
+
+      puts "method: PATCH, url: #{url}, params: #{params}" if debug
+
+      begin
+        res = RestClient.patch(url, JSON.generate(params), content_type.merge(headers))
+      rescue => e
+        e.response
+      end
     end
 
-    def put api_url, query = {}
-      res = RestClient.put(
-        base_url + api_url,
-        JSON.generate(private_params.merge(query)),
-        content_type.merge(headers)
-      )
+    def put api_url, query = {}, headers = {}
+      url    = base_url + api_url
+      params = private_params.merge(query)
+
+      puts "method: PUT, url: #{url}, params: #{params}" if debug
+
+      begin
+        res = RestClient.put(url, JSON.generate(params), content_type.merge(headers))
+      rescue => e
+        e.response
+      end
     end
 
-    def delete api_url, params = {}
-      res = RestClient.delete(
-        base_url + api_url,
-        params: private_params.merge(params),
-      )
+    def delete api_url, options = {}
+      url    = base_url + api_url
+      params = private_params.merge(options)
+
+      puts "method: DELETE, url: #{url}, params: #{params}" if debug
+
+      begin
+        res = RestClient.delete(url, params)
+      rescue => e
+        e.response
+      end
     end
 
     def base_url
@@ -63,11 +92,7 @@ module RestclientApiBase
     end
 
     def content_type
-      @content_type ||= { content_type: :json, accept: :json }
-    end
-
-    def content_type= type
-      @content_type = { content_type: type, accept: type }
+      { content_type: :json, accept: :json }
     end
 
     def private_params
@@ -78,5 +103,16 @@ module RestclientApiBase
       raise 'the private params must be a hash' unless params.is_a? Hash
       @private_params = params
     end
+
+    def logger_name
+      @logger_name ||= self.to_s.downcase.gsub(/::/, '_')
+    end
+
+    def write_log *args
+      logger  = Lumberjack::Logger.new("log/#{logger_name}.log")
+      logger.info(args.join('-'))
+    end
+
+    alias :write_api_log :write_log
   end
-end
+end

data/{restclinet_api_base.gemspec → restclient_api_base.gemspec}

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client", "~> 1.7"
+  spec.add_dependency "lumberjack", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'minitest/autorun'
 require File.dirname(__FILE__) + '/../lib/restclient_api_base'
 

data/test/test_restclient_api_base.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestRestclientApiBase < Minitest::Test
@@ -11,10 +13,14 @@ class TestRestclientApiBase < Minitest::Test
 
     self.base_url       = 'https://api.github.com'
     self.private_params = {}
+    self.debug = true
   end
 
   def test_get
     list = TestClient.get(@list_url)
+    assert_equal 200, list.code, 'the http status code is 200'
+    assert_equal "application/json; charset=utf-8", list.headers[:content_type]
+    assert list.cookies
     assert_equal true, JSON.parse(list).is_a?(Array)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restclient_api_base
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1.1
 platform: ruby
 authors:
 - Spirit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: lumberjack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ files:
 - lib/concern.rb
 - lib/restclient_api_base.rb
 - lib/restclient_api_base/version.rb
-- restclinet_api_base.gemspec
+- restclient_api_base.gemspec
 - test/test_helper.rb
 - test/test_restclient_api_base.rb
 homepage: https://github.com/NaixSpirit/restclient_api_base