ebay_browse_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dee47b6bb3e60fb589174d721f4c9ddbb446161efaa66be7f652c3450454853d
+  data.tar.gz: 5ac2bf3f81c8b3ac4338724d1078538a695d00739a561a63ab2de2a88b01ce5f
+SHA512:
+  metadata.gz: 16167ac6d46027cf917cf232e69fa44ab4d961593856d13ab9c360437ceb46eb4edcaffbd78741ccd49d4b079ada43105aaa059fe1538a1099790089ebf4fda1
+  data.tar.gz: 1c1359a413aaea3bef50ac299a7fce8646dd6a217a22aefec534d54c9aa1c993b5e7eab6af533455abb01e82d2fe1fc3846cd3e58e5f87cbf23b2efdeafef52d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.gem
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at admin@example.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+ruby "2.7.1"
+
+# Specify your gem's dependencies in ebay_browse_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,46 @@
+# EbayBrowseApi
+
+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/ebay_browse_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+This Gem is a basic wrapper for https://developer.ebay.com/api-docs/buy/static/api-browse.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ebay_browse_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ebay_browse_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/ebay_browse_api. 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/[USERNAME]/ebay_browse_api/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 EbayBrowseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ebay_browse_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ebay_browse_api"
+
+# 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/ebay_browse_api.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/ebay_browse_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ebay_browse_api"
+  spec.version       = EbayBrowseApi::VERSION
+  spec.authors       = ["Ohad Dahan"]
+  spec.email         = ["ohaddahan@gmail.com"]
+
+  spec.summary       = %q{Basic wrapper for https://developer.ebay.com/api-docs/buy/static/api-browse.html}
+  spec.description   = %q{Basic wrapper for https://developer.ebay.com/api-docs/buy/static/api-browse.html}
+  spec.homepage      = "https://github.com/ohaddahan/ebay_browse_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ohaddahan/ebay_browse_api"
+  spec.metadata["changelog_uri"] = "https://github.com/ohaddahan/ebay_browse_api"
+
+  # 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_development_dependency "rspec", "~> 3.9"
+  spec.add_dependency "typhoeus", "~> 1.4.0"
+  spec.add_dependency "oj", "~> 3.10.6"
+  spec.add_dependency "date", "~> 3.0.0"
+end

data/lib/ebay_browse_api.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+require "ebay_browse_api/version"
+require 'date'
+require 'typhoeus'
+require 'base64'
+require 'oj'
+
+
+module EbayBrowseApi
+  class Error < StandardError; end
+  # Your code goes here...
+  class EbayBrowseApiClient
+    attr_reader :ru_name, :client_id, :secret_id, :ebay_marketplace_id, :enc, :get_access_token_headers
+    attr_reader :get_access_token_body, :get_access_token_options, :access_token, :search_headers, :search_options
+    attr_reader :search_filter_params, :get_access_token_resp, :get_access_token_json, :search_resp, :search_json
+    attr_reader :init_time, :expires_in, :expire_date
+
+    class << self
+      attr_reader :get_access_token_url, :search_url
+
+      def parse_json(json, **kwargs)
+        begin
+          ( json.is_a?(String) && !json.empty? ) ? hash = Oj.load(json, **kwargs) : hash = {}
+        rescue Oj::ParseError
+          hash = {}
+        end
+        hash
+      end
+
+      def date_time(year: nil, month: nil, day: nil, diff_year: 0, diff_month: 0, diff_day: 0)
+        now = DateTime.now
+        DateTime.new((year || now.year) - diff_year,
+                     (month || now.month) - diff_month,
+                     (day || now.day) - diff_day).
+          strftime("%Y-%m-%dT00:00:00Z")
+      end
+    end
+
+    @get_access_token_url = 'https://api.ebay.com/identity/v1/oauth2/token'
+    @search_url = 'https://api.ebay.com/buy/browse/v1/item_summary/search'
+
+
+    def initialize(
+      ru_name: ENV["RU_NAME"],
+      client_id: ENV["CLIENT_ID"],
+      secret_id: ENV["SECRET_ID"],
+      ebay_marketplace_id: "EBAY_US"
+    )
+      @init_time = nil
+      @expires_in = nil
+      @expire_date = nil
+      @ru_name = ru_name
+      @client_id = client_id
+      @secret_id = secret_id
+      @ebay_marketplace_id = ebay_marketplace_id
+      @enc = Base64.encode64("#{@client_id}:#{@secret_id}").gsub(/\n/,'')
+      @search_filter_params = {}
+      @access_token = nil
+      @get_access_token_resp = nil
+      @get_access_token_json = nil
+      @search_resp = nil
+      @search_json = nil
+    end
+
+    def clear_search_params
+      @search_filter_params.clear
+    end
+
+    def prepare_get_access_token
+      @get_access_token_headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'Accept' => 'application/json',
+        'Accept-Charset' => 'utf-8',
+        'Authorization' => "Basic #{@enc}",
+        'X-EBAY-C-MARKETPLACE-ID' => @ebay_marketplace_id,
+      }
+      @get_access_token_body = "grant_type=client_credentials&redirect_uri=#{@ru_name}&scope=https://api.ebay.com/oauth/api_scope"
+      @get_access_token_options = {
+        headers: @get_access_token_headers,
+        followlocation: true,
+        body: @get_access_token_body
+      }
+    end
+
+    def get_access_token
+      prepare_get_access_token
+      @init_time = DateTime.now
+      @get_access_token_resp = Typhoeus::Request.post(EbayBrowseApiClient.get_access_token_url, @get_access_token_options)
+      @get_access_token_json = EbayBrowseApiClient.parse_json(@get_access_token_resp.response_body)
+      @expires_in = @get_access_token_json.fetch('expires_in',nil).to_i
+      @expire_date = @init_time + @expires_in
+      @access_token = @get_access_token_json.fetch('access_token',nil)
+    end
+
+    def prepare_search
+      @search_headers = {
+        'Accept' => 'application/json',
+        'Accept-Charset' => 'utf-8',
+        'Authorization' => "Bearer #{@access_token}",
+        'X-EBAY-C-MARKETPLACE-ID' => @ebay_marketplace_id,
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def add_search_param(param_name, param_value)
+      @search_filter_params[param_name] ||= String.new
+      @search_filter_params[param_name] << "#{param_value}"
+    end
+
+    def add_search_param_filter(param_name, param_value)
+      @search_filter_params[:filter] ||= String.new
+      @search_filter_params[:filter] << "&" unless @search_filter_params[:filter].empty?
+      @search_filter_params[:filter] << "#{param_name}:#{param_value}"
+    end
+
+    def run_search(params = nil)
+      prepare_search
+      @search_filter_params = params unless params.nil?
+      @search_options = {
+        headers: @search_headers,
+        followlocation: true,
+        params: @search_filter_params
+      }
+      @search_resp = Typhoeus::Request.get(EbayBrowseApiClient.search_url, @search_options)
+      @search_json = EbayBrowseApiClient.parse_json(@search_resp.response_body)
+    end
+  end
+end

data/lib/ebay_browse_api/version.rb

@@ -0,0 +1,3 @@
+module EbayBrowseApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ebay_browse_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ohad Dahan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+- !ruby/object:Gem::Dependency
+  name: date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Basic wrapper for https://developer.ebay.com/api-docs/buy/static/api-browse.html
+email:
+- ohaddahan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ebay_browse_api.gemspec
+- lib/ebay_browse_api.rb
+- lib/ebay_browse_api/version.rb
+homepage: https://github.com/ohaddahan/ebay_browse_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ohaddahan/ebay_browse_api
+  source_code_uri: https://github.com/ohaddahan/ebay_browse_api
+  changelog_uri: https://github.com/ohaddahan/ebay_browse_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Basic wrapper for https://developer.ebay.com/api-docs/buy/static/api-browse.html
+test_files: []