popshops-api 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a76d6ac0bc4d72065087b079b7dd17f7d079a3e
+  data.tar.gz: e066d2c165989834612d796cb88fe5a7577d0b93
+SHA512:
+  metadata.gz: 977aa3f9c3a7faf78c9dcbc843a0816920b5cb6a1f062d5a83345fc0655227e5b462a97c0f69adc503851aae02f04d2beb58668a08a33c5c56ffeb7e69257d7c
+  data.tar.gz: 579d0268afa4f12a87bef9a7751aac45601401cb4e94df65f5bfec64cec6656e11ece2cede12d49e6ec4de7199116fec63800f6e7e76c026dc720717c737f3c1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.env

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in popshops.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Eggett
+
+MIT License
+
+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,75 @@
+# Popshops
+
+A lightweight Ruby wrapper for communicating with the latest PopShops API (v3).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'popshops'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install popshops
+
+## Usage
+
+`require 'popshops-api'` as needed
+
+Initialize the Popshops API
+
+``` ruby
+popshops = Popshops::Api.new('api_key_value', 'catalog_key_value' )
+```
+
+Options:
+* api_key: Required
+* catalog_key: Optional, but needed in many calls.
+* private_api_key: Optional, if your account supports it.
+* format: Optional. Can be :json or :xml. Defaults to :json
+
+You can always switch popshops catalogs by reinitializing popshops, or utilizing the following method:
+
+``` ruby
+popshops.use_catalog('new_catalog_key')
+```
+You're now ready to start receiving data from Popshops.
+All of the PopShops API methods are available as:
+
+* find_products
+* find_coupons_and_deals
+* find_merchants
+* list_categories
+* list_merchant_types
+* list_deal_types
+* list_networks
+* list_countries
+* list_keywords
+
+### [Find Products](http://popshops.com/support/api-3-products)
+
+Product calls are used to get all information related to products, and the specific merchant offers for those products. One thing to note is that only offers will have affiliate links associated with them, the product itself will not have an affiliate URL.
+
+To lookup all products in your catalog, call:
+``` ruby
+popshops.find_products
+```
+
+To search for products by keyword, call:
+```
+popshops.find_products(keyword: 'ipad')
+```
+
+More details to come for other sections.
+
+## Contributing
+
+1. Fork it ( http://github.com/beneggett/popshops-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/popshops.rb

@@ -0,0 +1,66 @@
+# require "popshops/version"
+require "rubygems"
+require "httparty"
+require "hashie"
+
+module Popshops
+  class Api
+    include HTTParty
+    base_uri 'api.popshops.com/v3'
+    attr_accessor :api_key, :catalog_key, :private_api_key, :format
+
+    def initialize(api_key, catalog_key = nil, private_api_key = nil, format = :json)
+      @api_key = api_key
+      @catalog_key = catalog_key
+      @private_api_key = private_api_key
+      @format = format
+    end
+
+    def use_catalog(catalog_key)
+      @catalog_key = catalog_key
+    end
+
+    def find_products(options={})
+      Hashie::Mash.new( self.class.get "/products.#{@format}", query: merged(options) )
+    end
+
+    def find_coupons_and_deals(options={})
+      Hashie::Mash.new( self.class.get "/deals.#{@format}", query: merged(options) )
+    end
+
+    def find_merchants(options={})
+      Hashie::Mash.new( self.class.get "/merchants.#{@format}", query: merged(options) )
+    end
+
+    def list_categories(options={})
+      Hashie::Mash.new( self.class.get "/categories.#{@format}", query: merged(options) )
+    end
+
+    def list_merchant_types(options={})
+      Hashie::Mash.new( self.class.get "/merchant_types.#{@format}", query: merged(options) )
+    end
+
+    def list_deal_types(options={})
+      Hashie::Mash.new( self.class.get "/deal_types.#{@format}", query: merged(options) )
+    end
+
+    def list_networks(options={})
+      Hashie::Mash.new( self.class.get "/networks.#{@format}", query: merged(options) )
+    end
+
+    def list_countries(options={})
+      Hashie::Mash.new( self.class.get "/countries.#{@format}", query: merged(options) )
+    end
+
+    def list_keywords(options={})
+      Hashie::Mash.new( self.class.get "/keywords.#{@format}", query: merged(options) )
+    end
+
+    private
+    # This is used in all calls to merge our account & catalog parameters into the options queries
+    def merged(options)
+      { account: @api_key, catalog: @catalog_key}.merge(options)
+    end
+
+  end
+end

data/lib/popshops/version.rb

@@ -0,0 +1,3 @@
+module Popshops
+  VERSION = "2.0.0"
+end

data/popshops.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'popshops/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "popshops-api"
+  spec.version       = Popshops::VERSION
+  spec.authors       = ["Ben Eggett"]
+  spec.email         = ["beneggett@gmail.com"]
+  spec.summary       = %q{A Ruby wrapper for working with Popshops latest API (v3).}
+  spec.description   = %q{A simple ruby wrapper using httparty and Hashie to communicate with popshops API methods and work with data in nice ruby way.}
+  spec.homepage      = "http://www.github.com/beneggett/popshops-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "httparty", "~> 0.8.0"
+  spec.add_dependency "hashie", "~> 2.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: popshops-api
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Ben Eggett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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'
+description: A simple ruby wrapper using httparty and Hashie to communicate with popshops
+  API methods and work with data in nice ruby way.
+email:
+- beneggett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/popshops.rb
+- lib/popshops/version.rb
+- popshops.gemspec
+homepage: http://www.github.com/beneggett/popshops-api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for working with Popshops latest API (v3).
+test_files: []