keywords_everywhere 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3d07491afe85d0828f5d8803feb6b9654c7174de1090dc91030ef6810f27559
+  data.tar.gz: 6c858f17aa1e209ab4823a83ca162d9852a7da7cfc5d0b35943ced1548934ac9
+SHA512:
+  metadata.gz: cc737c42291e12b3d4cde4e658a74334ba780149ab3b5d544a9b897f4b06958779f490b2702e8ea1437b8ad2cc088b620e458554211342d1bca9a6521317c913
+  data.tar.gz: 3ee10fa75db56c82a7e3835e6f40734bf6439ad016a76dbdf73e892d44b76a63ea6f2fc798dde79acdbee5ff25c0396f832420468bcba216c17df2d95d1f8d21

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keywords_everywhere.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sead Feng
+
+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,56 @@
+# KeywordsEverywhere
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/keywords_everywhere`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keywords_everywhere'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install keywords_everywhere
+
+## Usage
+
+# configure
+```ruby
+KeywordsEverywhere.configure do |config|
+      config.secret_key = 'some_key'
+end
+c = KeywordsEverywhere::Client.new
+c.search_items(['nike','hp'])
+```
+# or 
+```ruby
+c = KeywordsEverywhere::Client.new(secret_key: 'some_key')
+c.search_items(['nike','hp'])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seadfeng/keywords_everywhere. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/seadfeng/keywords_everywhere/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the KeywordsEverywhere project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/seadfeng/keywords_everywhere/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keywords_everywhere"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/keywords_everywhere.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/keywords_everywhere/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keywords_everywhere"
+  spec.version       = KeywordsEverywhere::VERSION
+  spec.authors       = ["Sead Feng"]
+  spec.email         = ["seadfeng@icoud.com"]
+
+  spec.summary       = %q{Client library for KeywordsEverywhere}
+  spec.homepage      = "https://github.com/seadfeng/keywords_everywhere"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 2.1.0'
+end

data/lib/keywords_everywhere/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require 'rest-client'
+module KeywordsEverywhere
+    class Client
+        attr_accessor :source, :currency, :market
+        attr_reader :response, :secret_key
+
+        def initialize( 
+            secret_key:     KeywordsEverywhere.secret_key       || ENV['KW_SECRET'],
+            market:         KeywordsEverywhere.market           || DEFAULT_MARKET,  
+            source:         KeywordsEverywhere.source           || DEFAULT_SOURCE,
+            currency:       KeywordsEverywhere.currency         || DEFAULT_CURRENCY 
+        ) 
+
+            @source = source.to_s.downcase
+            @secret_key = secret_key
+            @market = market.to_s.downcase
+            @currency = currency.to_s.downcase
+            
+        end
+
+        def search_items(keywords)
+            if keywords.is_a?(String)
+                keywords = [keywords] 
+            end
+            raise StandardError, "Keyword Up to 100" if keywords.size > 100 # https://api.keywordseverywhere.com/docs/#/keywords/get_keywords_data
+            
+            client = rest_client(   method: :post, 
+                                    url: "https://api.keywordseverywhere.com/v1/get_keyword_data", 
+                                    payload: payload( kw: keywords ),
+                                    headers: headers )
+            @response = JSON.parse(client.body)
+            to_items
+        end
+
+        def credits
+            response.dig('credits')
+        end
+
+        def time
+            response.dig('time')
+        end
+
+        def list
+            List.new(response.dig('data'))
+        end
+
+        def to_items
+            list.to_items
+        end
+
+        protected
+
+        def payload(merge_params = {} )
+            { 
+                dataSource: source, 
+                country: market, 
+                currency: currency
+            }.merge(merge_params)
+        end
+
+        def headers
+            {  
+                "authority": "api.keywordseverywhere.com",
+                "accept": "application/json",
+                "authorization": "Bearer #{secret_key}",
+            }
+        end
+
+        private
+
+        def rest_client( opts = {} ) 
+            begin
+                RestClient::Request.execute(opts)
+            rescue RestClient::ExceptionWithResponse  => e
+                case e.http_code 
+                when 301, 302, 307 
+                  e.response.follow_redirection
+                else 
+                  raise
+                end
+            end
+        end
+
+    end
+end

data/lib/keywords_everywhere/item.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'forwardable'
+module KeywordsEverywhere
+  class Item
+    extend Forwardable
+    attr_accessor :hash 
+
+    def_delegators :@hash, :dig, :to_json
+
+    def initialize(data)
+      @hash = data
+    end
+
+    def vol
+        get(%w{vol})
+    end
+
+    def cpc
+        get(%w{cpc})
+    end
+
+    def keyword
+        get(%w{keyword})
+    end
+
+    def competition
+        get(%w{competition})
+    end
+
+    def trend
+        get(%w{trend})
+    end
+
+    def get(keys)
+        @hash.dig(*keys)
+    end
+
+  end
+end

data/lib/keywords_everywhere/list.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'forwardable'
+module KeywordsEverywhere
+  class List
+    extend Forwardable
+    attr_accessor :items
+
+    def_delegators :@items, :to_json, :size
+
+    def initialize(data)
+      @items = data
+    end
+
+    def self.to_items(data)
+        data.map {|d| Item.new(d)}
+    end
+
+    def to_items
+        items.map {|d| Item.new(d)}
+    end
+
+  end
+end

data/lib/keywords_everywhere/version.rb

@@ -0,0 +1,3 @@
+module KeywordsEverywhere
+  VERSION = "0.1.0".freeze
+end

data/lib/keywords_everywhere.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require "keywords_everywhere/version"
+
+require 'keywords_everywhere/client'
+require 'keywords_everywhere/list'
+require 'keywords_everywhere/item'
+
+require 'json'
+
+module KeywordsEverywhere
+  class Error < StandardError; end
+  DEFAULT_MARKET = :us
+  DEFAULT_SOURCE  = :gkp
+  DEFAULT_CURRENCY = :usd 
+
+
+  class << self
+    attr_accessor :secret_key, :source, :market, :currency
+    
+    def configure
+      yield self
+      true
+    end
+    alias_method :config, :configure
+  end
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: keywords_everywhere
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sead Feng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description:
+email:
+- seadfeng@icoud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keywords_everywhere.gemspec
+- lib/keywords_everywhere.rb
+- lib/keywords_everywhere/client.rb
+- lib/keywords_everywhere/item.rb
+- lib/keywords_everywhere/list.rb
+- lib/keywords_everywhere/version.rb
+homepage: https://github.com/seadfeng/keywords_everywhere
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seadfeng/keywords_everywhere
+  source_code_uri: https://github.com/seadfeng/keywords_everywhere
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Client library for KeywordsEverywhere
+test_files: []