sogou-search-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5c716c3f0a2b1c807eb08265f4b9ee700ae33d7
-  data.tar.gz: c66b6cd0d0e800170161a24b8ebde867ce54fce7
+  metadata.gz: f0b4319eb56256bda906b575a99471628c16cb52
+  data.tar.gz: d782793fda116ba744b925f2ee86e513034d958b
 SHA512:
-  metadata.gz: 627e5d14ebd0314ecb7330761522375dff5a54fa20152d0177493120c44235ddcea00841f76b5285912a2e960afc5dfcffd49f3c2a112b12081f87fd5b1d6214
-  data.tar.gz: a944be7071287c114fc205fb730d55c8e763fd7ef57e005e94e0c32c279da5a5b75fb6d09bba2620ff1a3fd9434cb6b3c5b1419d448348b97a1fa747df6dfc54
+  metadata.gz: '0815c7bc00e9751202be2ff7f15a56ed610ebcfc55d9da8dbaef9ba074562183067fcc2becdeda5c26c388e349fe33ebb4ecedb8e6dd3750f1624965158e74b9'
+  data.tar.gz: 97ec1f5bc46fbe71520378396410617c08a60990cc464798be6a554d1bab58ccdb77b9f594fb1067c6b1738832b5ca91db7664c177eb797fffc6b8c2ac9d654e

data/README.md

@@ -6,3 +6,120 @@ A Client GEM for [Sogou Search API](http://apihome.sogou.com/document/ss/doc1-1.
 
 This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible
 changes when necessary.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sogou-search-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sogou-search-api
+
+## Usage
+
+### Basic usage
+
+To use an API, instantiate the service. For example to use the Campaign API:
+
+```ruby
+require 'sogou/search/api/auth'
+require 'sogou/search/api/service/account'
+require 'sogou/search/api/service/plan'
+
+#
+# Set your Sogou api credentials to ENVs
+#
+# ENV['SOGOU_API_TOKEN'] = 'xxxx'
+# ENV['SOGOU_USERNAME'] = 'xxxx'
+# ENV['SOGOU_PASSWORD'] = 'xxxx'
+
+include Sogou::Search::Api
+
+account = Service::Account.new
+account.authorization = Auth.get_application_default
+account.get_account_info(convert_regions_to_string: true) do |result, err|
+  if err != nil
+    p err
+  else
+    p result
+  end
+end
+
+```
+
+### Callbacks
+
+A block can be specified when making calls. If present, the block will be called with the result or error, rather than
+returning the result from the call or raising the error. Example:
+
+```ruby
+# Read account info
+account.get_account_info(convert_regions_to_string: true) do |result, err|
+  if err
+    # Handle error
+  else
+    # Handle response
+  end
+end
+```
+
+### Authorization using environment variables
+
+The [Sogou Search API Auth](https://github.com/forward3d/sogou-search-api/blob/master/lib/sogou/search/api/auth.rb) also supports authorization via environment variables. Simply set the following variables
+for your application:
+
+```sh
+SOGOU_API_TOKEN="YOUR SOGOU DEVELOPER API TOKEN"
+SOGOU_USERNAME="YOUR SOGOU USERNAME"
+SOGOU_PASSWORD="YOUR SOGOU PASSWORD"
+```
+
+## Logging
+
+The client includes a `Logger` instance that can be used to capture debugging information.
+
+To set the logging level for the client:
+
+```ruby
+Sogou::Search::Api.logger.level = Logger::DEBUG
+```
+
+When running in a Rails environment, the client will default to using `::Rails.logger`. If you
+prefer to use a separate logger instance for API calls, this can be changed via one of two ways.
+
+The first is to provide a new logger instance:
+
+```ruby
+Sogou::Search::Api.logger = Logger.new(STDERR)
+```
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/forward3d/sogou-search-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+We encourage contributors to follow [Bozhidar's ruby style guide](https://github.com/bbatsov/ruby-style-guide) in this project.
+
+Pull requests (with tests) are appreciated. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+
+If you report a bug and don't include a fix, please include a failing test.
+

data/lib/sogou/search/api/core/regions.rb

@@ -407,14 +407,16 @@ module Sogou
           # can be either Interger[] or Integer from
           # http://apihome.sogou.com/document/ss/doc9-1.jsp and
           # http://apihome.sogou.com/document/ss/doc9-2.jsp,
-          # But "regions" value is returned always as integer value.
-          # Unless we find the case for integer[], below method will work.
           #
           def convert_regions_to_string(results)
             if results.is_a?(Hash)
-              region = results['regions']
-              if region
-                results['regions'] = REGIONS_CODE.fetch(region.to_i, region)
+              regions = results['regions']
+              if regions
+                if regions.is_a?(Array)
+                  results['regions'] = regions.map { |r| REGIONS_CODE.fetch(r.to_i, r) }
+                else
+                  results['regions'] = REGIONS_CODE.fetch(regions.to_i, regions)
+                end
               end
             elsif results.is_a?(Array)
               results = results.map { |r| convert_regions_to_string(r) }

data/lib/sogou/search/api/version.rb

@@ -1,7 +1,7 @@
 module Sogou
   module Search
     module Api
-      VERSION = '0.0.1'
+      VERSION = '0.0.2'
 
       OS_VERSION = begin
         if RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sogou-search-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Min Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon