crowdin-api 0.0.4 → 0.0.5

data/README.md

@@ -28,8 +28,10 @@ Start by creating a connection to Crowdin with your credentials:
 
 ```ruby
 require 'crowdin-api'
+require 'logger'
 
 crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID, :account_key => ACCOUNT_KEY)
+crowdin.log = Logger.new $stderr
 ```
 
 Now you can make requests to the api.

data/lib/crowdin-api.rb

@@ -1,5 +1,4 @@
 require 'pp'
-require 'logger'
 require 'json'
 require 'rest-client'
 
@@ -7,13 +6,28 @@ require "crowdin-api/errors"
 require "crowdin-api/methods"
 require "crowdin-api/version"
 
-#log = Logger.new(STDOUT)
-#RestClient.log = log
-#log.level = Logger::DEBUG
 
+# The Crowdin::API library is used for interactions with a crowdin.net website.
+#
+# == Example
+#
+#   require 'crowdin-api'
+#   require 'logger'
+#
+#   crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID)
+#   crowdin.log = Logger.new($stderr)
+#
 module Crowdin
   class API
 
+    class << self
+      # Default logger for all Crowdin::API instances
+      #
+      #   Crowdin::API.log = Logger.new($stderr)
+      #
+      attr_accessor :log
+    end
+
     # Create a new API object using the given parameters.
     #
     # @param [String] api_key the authentication API key can be found on the project settings page
@@ -27,6 +41,8 @@ module Crowdin
       @account_key = options.delete(:account_key)
       @base_url    = options.delete(:base_url) || 'http://api.crowdin.net'
 
+      @log = nil
+
       options = {
         :headers                => {},
         :params                 => {},
@@ -65,6 +81,9 @@ module Crowdin
         }
       end
 
+      log.debug("args: #{@response.args}") if log
+      log.debug("body: #{@response.body}") if log
+
       if @response.headers[:content_disposition]
         filename = params[:output] || @response.headers[:content_disposition][/attachment; filename="(.+?)"/, 1]
         body = @response.body
@@ -86,6 +105,18 @@ module Crowdin
 
     end
 
+    # The current logger. If no logger has been set Crowdin::API.log is used.
+    #
+    def log
+      @log || Crowdin::API.log
+    end
+
+    # Sets the +logger+ used by this instance of Crowdin::API
+    #
+    def log= logger
+      @log = logger
+    end
+
     private
 
   end

data/lib/crowdin-api/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   class API
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client