gcs_api_gem 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f39f5ad6c2fbe1d0f008d6754c0b487da6b4e907
-  data.tar.gz: 332525d5462b31ca8388a045a040119b3edd4e08
+  metadata.gz: 3b1ea2ce3dab1cc8bec78eebfe4ec094771aead3
+  data.tar.gz: cd30351439e67035fc8a1f8e3d64d5f4ee71f9c3
 SHA512:
-  metadata.gz: f6b3366b478d493fc818cd7bc3e3cd444d012dc3071b5d13db1c4540c05b7afa87fccfbc05da8ce22cb8678f93bc22346b07a5ed768ea8616100bc8509d1a475
-  data.tar.gz: af930ac3ef7b737f858cb1481bb50b54023c229c30aaacb20e95e6e4147a631d78a12288d81612b202db84a32b14da609aae971f7f600ad4899297e83a4fd93f
+  metadata.gz: 90491d11b00bbfd521680153b67bf644facea5ffe40639aac23f2678a7a24f3b7bac193fd49a434b1e21f88c514326fc282b370856cc835534dc14c4d08c28df
+  data.tar.gz: 7be6cd60b4aea32cb7aaa715ce8b7b36dec4917f3a234beee027ca3e844dea0a69884bfb111a09b5a1a63267ebcc9708de289ca9630a3f5de744bc311e173b77

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 高橋　雄太
+Copyright (c) 2017 Yuta Takahashi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -45,35 +45,48 @@ If you want to know how to get GOOGLE_CUSTOME_SEARCH_ENGINE_ID and GOOGLE_API_KE
 Or see [here](http://ryutamaki.hatenablog.com/entry/2014/01/18/171640).
 
 ## Usage
+### In a program
 
 Write in your program as below:
 
 ```ruby
-GcsApiGem::SearchApu.rondom_image(<keyword>)
+obj.GcsApiGem::SearchApi.new
+obj.random_image(<keyword>)
 ```
 
 Then you get a random image searched by keyword.
 
-## Example
+#### Example
 
 ```
-> GcsApiGem::SearchApi.random_image('cat')
+> obj = GcsApiGem::SearchApi.new
+> obj.random_image('cat')
 => {
+    :keyword=>"cat",
     :title=>"Cute Cat - Chrome Web Store",
     :image=>"https://lh3.googleusercontent.com/FnN1_Jabl5WITJrHYLGv80r-GNSNAPI_nwrrSgHh8fRUh5fsHFMmPFkPOjaX16H5Pi-Fwotg=w640-h400-e365",
-    :search_result=>"320000000"
+    :search_result=>"320000000",
+    :start_index=>2
    }
 ```
 
-## Response
+#### Response
 
-Response of GcsApiGem::SearchApi.random_image is as below:
+Response of GcsApiGem::SearchApi#random_image is as below:
 
-| key           | detail                                        |
-| ------------- | --------------------------------------------- |
-| title         | The title of the web site that got the image. |
-| image         | The URL of the got image.                     |
-| search_result | Number of images hit in search.               |
+| key           | detail                                          |
+| ------------- | ----------------------------------------------- |
+| keyword       | It is using keyword to search image.            |
+| title         | The title of the web site that got the image.   |
+| image         | The URL of the got image.                       |
+| search_result | Number of images hit in search.                 |
+| start_index   | Number of page on which the image is displayed. |
+
+### In a command line
+
+Write in a command line as below:
+
+    $ gcs_api_gem -r cat
 
 ## Contributing
 

data/bin/gcs_api_gem

@@ -33,5 +33,6 @@ unless errors.count.zero?
   exit 1
 end
 
-p output(GcsApiGem::SearchApi.random_image(keyword))
+obj = GcsApiGem::SearchApi.new
+p output(obj.random_image(keyword))
 exit 0

data/gcs_api_gem.gemspec

@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "httpclient"
+  spec.add_runtime_dependency "httpclient", "~> 2.8.3"
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry", "0.10.4"
+  spec.add_development_dependency "pry-byebug", "3.5.1"
 end

data/lib/gcs_api_gem/search_api.rb

@@ -1,68 +1,105 @@
 module GcsApiGem
   # SearchApi
   class SearchApi
-    class << self
-      # Select one piece randomly from images searched by keyword
-      def random_image(keyword)
-        return { error: 'Please set KEY to environment variable.' } if key_is_ng?
-        return { error: 'Please set CSE_ID to environment variable.' } if cse_id_is_ng?
+    # Decide to what range of page you want to acquire
+    SEARCH_RANGE = 3
 
-        choice(fetch(keyword))
-      end
+    def initialize
+      @items = []
+      @search_result = nil
+      @keyword = nil
+      @start_index = nil
+    end
 
-      private
+    # Select one piece randomly from images searched by keyword
+    def random_image(keyword)
+      return { error: 'Please set KEY to environment variable.' } if key_is_ng?
+      return { error: 'Please set CSE_ID to environment variable.' } if cse_id_is_ng?
 
-      def key_is_ng?
-        blank?(ENV['KEY'])
-      end
+      choice(keyword)
+    end
 
-      def cse_id_is_ng?
-        blank?(ENV['CSE_ID'])
-      end
+    private
 
-      def url
-        'https://www.googleapis.com/customsearch/v1'
-      end
+    def key_is_ng?
+      blank?(ENV['KEY'])
+    end
 
-      def query(keyword)
-        {
-          'key' => ENV['KEY'],
-          'cx' => ENV['CSE_ID'],
-          'searchType' => 'image',
-          'q' => keyword,
-          'start' => rand(50) + 1
-        }
-      end
+    def cse_id_is_ng?
+      blank?(ENV['CSE_ID'])
+    end
 
-      def fetch(keyword)
-        client = HTTPClient.new
-        res = client.get(url, query(keyword))
-        JSON.parse res.body
-      end
+    def url
+      'https://www.googleapis.com/customsearch/v1'
+    end
 
-      def choice(res)
-        if blank?(res['error'])
-          if res['searchInformation']['totalResults'].to_i.zero?
-            return { error: 'Search result was 0.' }
-          end
-          formatted_item(res)
-        else
-          res['error']
-        end
-      end
+    def query(keyword)
+      {
+        'key' => ENV['KEY'],
+        'cx' => ENV['CSE_ID'],
+        'searchType' => 'image',
+        'q' => keyword,
+        'start' => rand(SEARCH_RANGE) + 1,
+        'imgType' => 'photo'
+      }
+    end
 
-      def blank?(obj)
-        obj.nil? || obj.empty?
-      end
+    def fetch(keyword)
+      client = HTTPClient.new
+      res = client.get(url, query(keyword))
+      JSON.parse res.body
+    end
 
-      def formatted_item(res)
-        item = res['items'][rand(res['items'].count)]
-        {
-          title: item['title'],
-          image: item['link'],
-          search_result: res['searchInformation']['totalResults']
-        }
+    def choice(keyword)
+      if @keyword != keyword
+        @keyword = keyword
+        pull_data
       end
+      formatted_item(select_item)
+    rescue => e
+      return { error: e.message }
+    end
+
+    def pull_data
+      p 'do pull_data'
+      res = fetch(@keyword)
+      check_error(res)
+
+      @items = res['items']
+      @search_result = res['searchInformation']['totalResults'].to_i
+      @start_index = res['queries']['request'][0]['startIndex']
+    end
+
+    def check_error(res)
+      raise res['error'].to_s unless blank?(res['error'])
+      raise 'Search result was 0.' if count_zero?(res)
+    end
+
+    def select_item
+      pull_data if @items.count.zero?
+
+      index = [*(0..@items.count - 1)].sample
+      item = @items[index]
+      @items.delete_at(index)
+      item
+    end
+
+    def blank?(obj)
+      obj.nil? || obj.empty?
+    end
+
+    def formatted_item(item)
+      {
+        keyword: @keyword,
+        title: item['title'],
+        image: item['link'],
+        search_result: @search_result,
+        start_index: @start_index
+      }
+    end
+
+    def count_zero?(res)
+      res['searchInformation']['totalResults'].to_i.zero?
     end
   end
 end

data/lib/gcs_api_gem/version.rb

@@ -1,3 +1,3 @@
 module GcsApiGem
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcs_api_gem
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuta Takahashi
@@ -14,16 +14,16 @@ dependencies:
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +70,30 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.1
 description: Google Custom Search API gem.
 email:
 - m1205123ing@gmail.com