rong_cloud_server 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8851d724f0063d44b4baec6498e55dbcb584ce2
-  data.tar.gz: 46cbca45d889185c5e3a2062c17d99f9d8a7df83
+  metadata.gz: 6be41c66282f7b2fede5bdcb34a09f19147480db
+  data.tar.gz: a9359a4d519e77a867bf10d32d484ec4629f743a
 SHA512:
-  metadata.gz: f8f62f13ef18c5c4541c34fae5df6969c73855f9955b910ebc1c3955d2688e0892dabe8d2a077bb8685bf9f7d805f082c1a0f214539448a81b2835415d5cfe97
-  data.tar.gz: 994b4805135d4b3113cf2638ad072f28fd9293be0329f3c61d5d048830f32e6e6f9f4f8a4f22bbcca330f8e60d978a142d7becf41f08baec84b9b39a9c5d9b09
+  metadata.gz: 3ef454bbea716cdebfcbfb9c603f2771111354f3aeb7618f8466828f47f547648ddd93d5ed554a68e4b389f8ec2c2037439c303111562d32700a0d7455e541bc
+  data.tar.gz: 409b2fc2ebb46cebaa8cc15251209c33365ccb45c2006855584ea226996b9951fab689186c2bf81f3de879e90a2af50cd4d00eedc4ba9bcb01461ee86347ea59

data/.gitignore

@@ -3,4 +3,5 @@ rong_cloud.log
 /doc
 .yardoc/
 Gemfile.lock
-coverage/
+coverage/
+log/

data/README.md

@@ -28,6 +28,8 @@ This repository implements most essential apis for [RongCloud Server API](http:/
     config.app_key = "APP_KEY"
     config.app_secret = "SECRET_KEY"
     # config.host = "http://api.cn.ronghub.com"   # default: https://api.cn.ronghub.com, use http here is just convenient for debugging
+    # config.timeout = 10 # set open timeout and read timeout in seconds for http request, default is 2 seconds
+    # config.debug_mode = true # if need to log request and response details, the log file is at "log/rong_cloud_debug.log", default is `false`
   end
   ```
 3. Use the instance of `RongCloud::Service` to talk to RongCloud Server:
@@ -57,7 +59,4 @@ ruby -Ilib -Itest -e 'ARGV.each { |f| require f }' ./test/**/*_test.rb
 ### How to contribute
 1. Fork this repo;
 2. Write your code and test;
-3. Open a new Pull Request.
-
-### TODO
-1. Logger support
+3. Open a new Pull Request.

data/lib/rong_cloud/configuration.rb

@@ -7,10 +7,11 @@ module RongCloud
     # The default host to accept connections, use a https protocol
     DEFAULT_HOST = "https://api.cn.ronghub.com".freeze
     DEFAULT_TIMEOUT = 2
+    DEFAULT_DEBUG_MODE = false
 
     module ModuleMethods
       attr_accessor :app_key, :app_secret
-      attr_writer :host, :timeout
+      attr_writer :host, :timeout, :debug_mode
 
       # Fetch the api host, the default is: https://api.cn.ronghub.com
       #
@@ -21,6 +22,10 @@ module RongCloud
       def timeout
         @timeout || DEFAULT_TIMEOUT
       end
+
+      def debug_mode
+        @debug_mode || DEFAULT_DEBUG_MODE
+      end
     end
     extend ModuleMethods
   end

data/lib/rong_cloud/request.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'json'
 require 'rong_cloud/signature'
+require 'logger'
 
 module RongCloud
   # Handle api request, based on Ruby's built-in Net::HTTP,
@@ -23,9 +24,11 @@ module RongCloud
       request_options = { use_ssl: use_ssl, open_timeout: timeout, read_timeout: timeout }
 
       res = Net::HTTP.start(uri.hostname, uri.port, request_options) do |http|
+        inspect_debug_informations(req, uri, request_options)
         http.request(req)
       end
 
+      inspect_debug_informations(res)
       handle_response(res)
     end
 
@@ -79,5 +82,29 @@ module RongCloud
         raise error
       end
     end
+
+    def inspect_debug_informations(*objects)
+      return unless RongCloud::Configuration.debug_mode
+
+      objects.each do |obj|
+        begin
+          case
+          when obj.is_a?(URI::Generic)
+            logger.debug("Requesting #{obj.hostname}:#{obj.port}")
+          when obj.is_a?(Net::HTTPGenericRequest)
+            logger.debug("request method: #{obj.method}, headers: #{obj.to_hash}, raw body: #{obj.body}")
+          when obj.is_a?(Net::HTTPResponse)
+            logger.debug("response headers: #{obj.to_hash}, raw body: #{obj.body}")
+          else
+            logger.debug(obj.inspect)
+          end
+        rescue
+        end
+      end
+    end
+
+    def logger
+      @logger ||= ::Logger.new("log/rong_cloud_debug.log")
+    end
   end
 end

data/rong_cloud.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.summary      = 'RongCloud Server API SDK'
   s.description  = 'RongCloud Server API in Ruby，http://www.rongcloud.cn/docs/server.html'
-  s.version      = '0.2.0'
+  s.version      = '0.2.1'
   s.files        = `git ls-files`.split("\n")
   s.authors      = ['Martin Hong']
   s.email        = 'hongzeqin@gmail.com'

data/test/test_helper.rb

@@ -14,6 +14,7 @@ end
 require 'minitest/autorun'
 require 'byebug'
 require 'rong_cloud'
+require 'fileutils'
 
 def rong_cloud_configure_with_settings
   RongCloud.configure do |config|
@@ -21,5 +22,8 @@ def rong_cloud_configure_with_settings
     config.app_secret = ENV["RONGCLOUD_APP_SECRET"]
     config.host = ENV["RONGCLOUD_API_HOST"] || "https://api.cn.ronghub.com"
     config.timeout = 10
+    config.debug_mode = true
+
+    FileUtils.mkdir_p "log/"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rong_cloud_server
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Martin Hong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-10 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest