google_images 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58fccef6cbf2dfdf07ce8b028d1be47b063a5275
+  data.tar.gz: 229f61f0a687cee0bda8af736d2e8b996c09c602
+SHA512:
+  metadata.gz: 35bd546f3ce9f6ad433eed60d7c758a80890063871741cd8df3a806689c07bd263636800c785b0921d0b0d906ee135f940401bbab0039afffdc3b2ba37c82dd2
+  data.tar.gz: 88171e3c84ebe9647abe830594eec51871b4674d971949c87c644cb8accc723df402aa62be2e2981bebe18c92abb5683a158a98a0056fe71bb81790b8ec6ef83

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sharipov Ruslan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# GoogleImages
+
+Simple Google Images API library for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_images'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_images
+
+## Usage
+
+    GoogleImages.search('ruby', img_size: 'xlarge')
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sharipov-ru/google_images. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'google_images'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/google_images.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_images/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_images"
+  spec.version       = GoogleImages::VERSION
+  spec.authors       = ["Sharipov Ruslan"]
+  spec.email         = ["sharipov.ru@gmail.com"]
+
+  spec.summary       = %q{Google Images Custom API client }
+  spec.description   = %q{Simple and reliable solution for interacting with Google Images Search API}
+  spec.homepage      = "http://github.com/sharipov-ru/google-images"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

data/lib/google_images.rb

@@ -0,0 +1,46 @@
+require 'google_images/version'
+require 'google_images/auth'
+require 'google_images/query'
+require 'google_images/query_executor'
+require 'google_images/mapper'
+
+# Namespace for classes and modules that handle Google Images search 
+module GoogleImages
+  # Google Images Lookup
+  #
+  # @param [String] text to perform search with
+  # @param [Hash] options the options perform search with
+  #
+  # @example Search images by `ruby` keyword
+  #   GoogleImages.search('ruby')
+  #
+  # @example Search images with keyword and optional parameters
+  #   GoogleImages.search('ruby', img_size: 'large', safe: 'high')
+  #
+  # @raise [GoogleImages::Errors::GeneralError]
+  # @raise [GoogleImages::Errors::NetworkError]
+  # @raise [GoogleImages::Errors::URLGenerationError] 
+  # @raise [GoogleImages::Errors::ResponseParsingError]
+  # @raise [GoogleImages::Errors::ImageMappingError]
+  #
+  # @return [Array<GoogleImages::Image] array of found images
+  def self.search(text, options = {})
+    query = Query.new(text, options)
+    images_hash = QueryExecutor.run(query, authentication)
+    Mapper.build_images(images_hash)
+  end
+
+  private
+
+  def self.authentication
+    Auth.new(key, cx)
+  end
+
+  def self.key
+    ENV['GOOGLE_IMAGES_KEY']
+  end
+
+  def self.cx
+    ENV['GOOGLE_IMAGES_CX']
+  end
+end

data/lib/google_images/auth.rb

@@ -0,0 +1,11 @@
+module GoogleImages
+  # A value-object which stores Google API authentication information
+  class Auth
+    attr_reader :key, :cx
+
+    def initialize(key, cx)
+      @key = key
+      @cx = cx
+    end
+  end
+end

data/lib/google_images/errors.rb

@@ -0,0 +1,4 @@
+module GoogleImages
+  module Errors
+  end
+end

data/lib/google_images/errors/general_error.rb

@@ -0,0 +1,5 @@
+module GoogleImages
+  module Errors
+    class GeneralError < StandardError; end;
+  end
+end

data/lib/google_images/errors/image_mapping_error.rb

@@ -0,0 +1,7 @@
+require 'google_images/errors/general_error'
+
+module GoogleImages
+  module Errors
+    class ImageMappingError < GeneralError; end;
+  end
+end

data/lib/google_images/errors/network_error.rb

@@ -0,0 +1,7 @@
+require 'google_images/errors/general_error'
+
+module GoogleImages
+  module Errors
+    class NetworkError < GeneralError; end;
+  end
+end

data/lib/google_images/errors/response_parsing_error.rb

@@ -0,0 +1,7 @@
+require 'google_images/errors/general_error'
+
+module GoogleImages
+  module Errors
+    class ResponseParsingError < GeneralError; end;
+  end
+end

data/lib/google_images/errors/url_generation_error.rb

@@ -0,0 +1,7 @@
+require 'google_images/errors/general_error'
+
+module GoogleImages
+  module Errors
+    class URLGenerationError < GeneralError; end;
+  end
+end

data/lib/google_images/image.rb

@@ -0,0 +1,21 @@
+module GoogleImages
+  class Image
+    attr_reader :title, :link, :context_link, :snippet, :mime, :byte_size,
+                :thumbnail_link, :thumbnail_height, :thumbnail_width,
+                :height, :width
+
+    def initialize(items_hash = {})
+      @title            = items_hash['title']
+      @link             = items_hash['link']
+      @context_link     = items_hash['image']['context_link']
+      @snippet          = items_hash['snippet']
+      @mime             = items_hash['mime']
+      @height           = items_hash['image']['height']
+      @width            = items_hash['image']['width']
+      @byte_size        = items_hash['image']['byte_size']
+      @thumbnail_link   = items_hash['image']['thumbnailLink']
+      @thumbnail_height = items_hash['image']['thumbnailHeight']
+      @thumbnail_width  = items_hash['image']['thumbnailWidth']
+    end
+  end
+end

data/lib/google_images/mapper.rb

@@ -0,0 +1,13 @@
+require 'google_images/image'
+require 'google_images/errors/image_mapping_error'
+
+module GoogleImages
+  module Mapper
+    def self.build_images(json)
+      items = json['items']
+      items.map { |item_hash| Image.new(item_hash) }
+    rescue => e
+      raise GoogleImages::Errors::ImageMappingError
+    end
+  end
+end

data/lib/google_images/network_requester.rb

@@ -0,0 +1,23 @@
+require 'http'
+require 'google_images/errors/network_error'
+
+module GoogleImages
+  # This class acts as a facade between http client library `http.rb` and
+  # our source code for abstracting library's entities and exceptions and using
+  # only needed part of the http client library API
+  module NetworkRequester
+    # Performs json GET request
+    #
+    # @param [String] url
+    #
+    # @example Get data from url
+    #   NetworkRequester.get("http://url")
+    #
+    # @raise [GoogleImages::Errors::NetworkError]
+    def self.get(url)
+      HTTP.headers(accept: 'application/json').get(url)
+    rescue => e
+      raise GoogleImages::Errors::NetworkError, 'Network Error'
+    end
+  end
+end

data/lib/google_images/query.rb

@@ -0,0 +1,39 @@
+require 'http'
+
+module GoogleImages
+  # Class which represent google_images gem's query API
+  class Query
+    SUPPORTED_API_PARAMS = [
+      :c2coff,
+      :cr,
+      :date_restrict,
+      :filter,
+      :googlehost,
+      :img_color_type,
+      :img_dominant_color,
+      :img_size,
+      :img_type,
+      :num,
+      :rights,
+      :safe
+    ]
+
+    attr_reader :search_term, :api_params
+
+    # Initialize a new Query keeping only those api params which are supported
+    #
+    # @param [String] search_term 
+    # @param [Hash] api_params 
+    #
+    # @return [GoogleImages::Query] query object
+    def initialize(search_term, api_params = {})
+      @search_term = search_term
+      @api_params = supported_api_params(api_params)
+    end
+
+    private
+    def supported_api_params(api_params)
+      api_params.select { |key, _| SUPPORTED_API_PARAMS.include?(key) }
+    end
+  end
+end

data/lib/google_images/query_executor.rb

@@ -0,0 +1,30 @@
+require 'google_images/url_builder'
+require 'google_images/network_requester'
+require 'google_images/errors/response_parsing_error'
+
+module GoogleImages
+  class QueryExecutor
+    # Execute the given query
+    #
+    # @param [GoogleImages::Query] query
+    # @param [GoogleImages::Auth] auth
+    # 
+    # @raise [GoogleImages::Errors::URLGenerationError]
+    # @raise [GoogleImages::Errors::NetworkError]
+    # @raise [GoogleImages::Errors::ResponseParsingError]
+    #
+    # @return [Hash] response hash
+    def self.run(query, auth)
+      url = URLBuilder.build(query, auth)
+      response = NetworkRequester.get(url)
+      parse_json(response)
+    end
+
+    private
+    def self.parse_json(response)
+      JSON.parse(response)
+    rescue JSON::ParserError
+      raise GoogleImages::Errors::ResponseParsingError
+    end
+  end
+end

data/lib/google_images/url_builder.rb

@@ -0,0 +1,43 @@
+require 'google_images/errors/url_generation_error'
+
+module GoogleImages
+  # Builds Google Images API - compatible URL
+  class URLBuilder
+    class << self
+      API_URL = 'https://www.googleapis.com/customsearch/v1'
+
+      def build(query, auth)
+        "#{API_URL}?q=#{query.search_term}&#{api_keys(auth)}&#{parameters(query)}"
+      rescue => e
+        raise GoogleImages::Errors::URLGenerationError
+      end
+    
+      private
+      def api_keys(auth)
+        "key=#{auth.key}&cx=#{auth.cx}"
+      end
+
+      def parameters(query)
+        google_api_params = {
+          searchType:       query.api_params[:search_type] || 'image',
+          alt:              query.api_params[:alt] || 'json',
+          safe:             query.api_params[:safe] || 'off',
+          num:              query.api_params[:num] || nil,
+          rights:           query.api_params[:rights] || nil,
+          imgSize:          query.api_params[:img_size] || nil,
+          imgType:          query.api_params[:img_type] || nil,
+          imgDominantColor: query.api_params[:img_dominant_color] || nil,
+          imgColorType:     query.api_params[:img_color_type] || nil,
+          c2coff:           query.api_params[:c2coff] || nil,
+          cr:               query.api_params[:cr] || nil,
+          filter:           query.api_params[:filter] || nil,
+          googlehost:       query.api_params[:googlehost] || nil
+        }
+
+        google_api_params.map do |key, value|
+          value ? "#{key}=#{value}" : nil
+        end.compact.join("&")
+      end
+    end
+  end
+end

data/lib/google_images/version.rb

@@ -0,0 +1,3 @@
+module GoogleImages
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: google_images
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sharipov Ruslan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Simple and reliable solution for interacting with Google Images Search
+  API
+email:
+- sharipov.ru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_images.gemspec
+- lib/google_images.rb
+- lib/google_images/auth.rb
+- lib/google_images/errors.rb
+- lib/google_images/errors/general_error.rb
+- lib/google_images/errors/image_mapping_error.rb
+- lib/google_images/errors/network_error.rb
+- lib/google_images/errors/response_parsing_error.rb
+- lib/google_images/errors/url_generation_error.rb
+- lib/google_images/image.rb
+- lib/google_images/mapper.rb
+- lib/google_images/network_requester.rb
+- lib/google_images/query.rb
+- lib/google_images/query_executor.rb
+- lib/google_images/url_builder.rb
+- lib/google_images/version.rb
+homepage: http://github.com/sharipov-ru/google-images
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Google Images Custom API client
+test_files: []
+has_rdoc: