tesco_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b25b0f2276329359cb2fcb0ea97b1a50467d7daa
+  data.tar.gz: 56f845caee7bf60a4f4b56ffe6405359b8960d1c
+SHA512:
+  metadata.gz: ff8709a6d91996bbd0fb0b75f98c3f9c842e03f1daadfef25c4007aa70639fb51f0a81ecfbfa773dd2bd4d1b415b9fa96f1fea96d7ae867aa4833297cc70d798
+  data.tar.gz: bdc43d6321a9ed18ce35238da811e8dd7c9f88bc0a924dcdd45ef1b98f7a73acc6c5531d0abfb3b573dc8aa8531db7c33553745bc17ae454f77ba0aa40639b5b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 William Clarke
+
+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.org

@@ -0,0 +1,42 @@
+* TescoRb
+** Usage Examples:
+
+#+BEGIN_SRC ruby
+client = TescoRb.new(YOUR_API_KEY)
+
+# To search for items:
+client.item.search('bananas')
+client.item.search('bananas', limit: 10)
+client.item.search('bananas', limit: 10, offset: 10)
+
+# To search for Shops:
+client.store(near: 'SW5 4YY')
+client.store(near: 'SW5 4YY', limit: 5)
+client.store(filter: 'isoCountryCode:GB AND category:Store AND facilities:DBT')
+#+END_SRC
+
+** Installation
+
+  Add this line to your application's Gemfile:
+
+#+BEGIN_SRC sh
+gem 'tesco_rb'
+#+END_SRC
+
+  And then execute:
+
+#+BEGIN_SRC sh
+$ bundle
+#+END_SRC
+
+  Or install it yourself as:
+
+#+BEGIN_SRC sh
+$ gem install tesco_rb
+#+END_SRC
+
+
+*** Todos
+    - `client.item.search('bananas')` syntax; add `.search` method
+      - This would involve creating new 'items' holding class (currently just an Array)
+    - DRY / subclass requesters

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 "tesco_rb"
+
+# 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

data/bin/setup

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

data/lib/tesco_rb/address.rb

@@ -0,0 +1,9 @@
+module TescoRb
+  class Address
+    include RepresentationHelper
+    attr_reader :lines, :town, :postcode
+    def initialize(hash)
+      set [:lines, :town, :postcode], hash
+    end
+  end
+end

data/lib/tesco_rb/client.rb

@@ -0,0 +1,34 @@
+require 'tesco_rb/store_requester'
+require 'tesco_rb/item_requester'
+require 'httparty'
+
+module TescoRb
+  # The main class to coordinate HTTP requests
+  class Client
+    include HTTParty
+    attr_reader :api_key
+
+    base_uri 'https://dev.tescolabs.com/'
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def store(options = {})
+      StoreRequester.new.create_representations(self, options)
+    end
+
+    def item(options = {})
+      ItemRequester.new.create_representations(self, options)
+    end
+
+    def get(url, options = {})
+      self.class.get(url, options.merge(default_options))
+    end
+
+    def default_options
+      { headers:
+          { 'Ocp-Apim-Subscription-Key' => ENV['TESCO_API_KEY'] } }
+    end
+  end
+end

data/lib/tesco_rb/item.rb

@@ -0,0 +1,28 @@
+require_relative 'representation_helper'
+require_relative 'address'
+
+module TescoRb
+  class Item
+    include RepresentationHelper
+
+    def self.fields
+      %I( image tpnb PromotionDescription
+          ContentsMeasureType name UnitOfSale
+          AverageSellingUnitWeight UnitQuantity
+          ContentsQuantity price unitprice)
+    end
+
+    attr_reader(*fields)
+
+    def initialize(location)
+      set self.class.fields, location
+    end
+
+    def ==(other)
+      self.class.fields.all? do |method_name|
+        send(method_name) == other.send(method_name)
+      end
+    end
+
+  end
+end

data/lib/tesco_rb/item_requester.rb

@@ -0,0 +1,45 @@
+require_relative 'item'
+
+# TODO: subclass these requesters as they share loads of logic.
+module TescoRb
+  class ItemRequester
+    def create_representations(client, hash_args)
+      response = request(client, update_args(hash_args))
+      products = response['uk']['ghs']['products']['results']
+      products.map do |json|
+        Item.new(json)
+      end
+    rescue => e
+      p e
+    end
+
+    private
+
+    def update_args(args)
+      args[:offset] ||= 0
+      args[:limit] ||= 1
+      args
+    end
+
+    def request(client, hash_args)
+      client.get '/grocery/products', query: hash_args
+    rescue => e
+      p e
+    end
+
+    def parse_json(request)
+      JSON.parse(request.body)
+    rescue JSON::ParserError => e
+      p e
+      { 'results' => [] }
+    end
+
+  end
+
+  class GeoCoordinates
+  end
+
+  class OpeningHours
+  end
+
+end

data/lib/tesco_rb/representation_helper.rb

@@ -0,0 +1,9 @@
+module TescoRb
+  module RepresentationHelper
+    def set(attributes, hash)
+      Array.new(attributes).each do |attribute|
+        instance_variable_set("@#{attribute}", hash[attribute.to_s])
+      end
+    end
+  end
+end

data/lib/tesco_rb/store.rb

@@ -0,0 +1,38 @@
+require_relative 'representation_helper'
+require_relative 'address'
+
+module TescoRb
+  class Store
+    include RepresentationHelper
+    attr_reader :address
+
+    def self.fields
+      [:id, :name, :altIds, :region, :geo,
+       :classification, :status, :facilities,
+       :openingHours]
+    end
+
+    attr_reader(*fields)
+
+    def initialize(location)
+      set self.class.fields, location
+      begin
+        address_json = location.fetch('contact').
+                       fetch('address')
+        @address = Address.new(address_json)
+      rescue KeyError => e
+        p e
+      end
+    end
+
+    def ==(other)
+      self.class.fields.all? do |method_name|
+        send(method_name) == other.send(method_name)
+      end
+    end
+
+    # def set_fields
+    #   fields.each { |field| attr_reader field }
+    # end
+  end
+end

data/lib/tesco_rb/store_requester.rb

@@ -0,0 +1,46 @@
+require_relative 'store'
+
+module TescoRb
+  class StoreRequester
+    def create_representations(client, hash_args)
+      response = request(client, update_args(hash_args))
+      json_response = parse_json(response)
+      return [] unless json_response.is_a?(Hash) &&
+                       json_response['results']
+      json_response['results'].map do |json|
+        Store.new(json.fetch('location'))
+      end
+    end
+
+    private
+
+    def update_args(args)
+      if args[:near]
+        near_args = args.delete(:near)
+        args[:sort] = "near:\"#{near_args}\""
+      end
+      args
+    end
+
+    def request(client, hash_args)
+      client.get '/locations/search', query: hash_args
+    rescue => e
+      p e
+    end
+
+    def parse_json(request)
+      JSON.parse(request.body)
+    rescue JSON::ParserError => e
+      p e
+      { 'results' => [] }
+    end
+
+  end
+
+  class GeoCoordinates
+  end
+
+  class OpeningHours
+  end
+
+end

data/lib/tesco_rb/version.rb

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

data/lib/tesco_rb.rb

@@ -0,0 +1,12 @@
+require "tesco_rb/version"
+require "tesco_rb/client"
+require "tesco_rb/store"
+require "tesco_rb/store_requester"
+require "tesco_rb/representation_helper"
+
+# Wrapper for the tescolabs api:
+# https://devportal.tescolabs.com/docs/services
+
+# module TescoRb
+#   # Your code goes here...
+# end

data/tesco_rb.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tesco_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tesco_rb'
+  spec.version       = TescoRb::VERSION
+  spec.authors       = ['William Clarke']
+  spec.email         = ['wmmclarke@gmail.com']
+
+  spec.summary       = 'A wrapper to the Tesco API'
+  spec.homepage      = 'https://github.com/wmmc/tesco_rb'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_runtime_dependency 'httparty', '~> 0.14.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  # spec.add_development_dependency 'minitest-vcr', '~> 1.4.0'
+  spec.add_development_dependency 'vcr', '~> 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.1.0'
+  spec.add_development_dependency 'dotenv', '~> 2.1.1'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: tesco_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Clarke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: 
+email:
+- wmmclarke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tesco_rb.rb
+- lib/tesco_rb/address.rb
+- lib/tesco_rb/client.rb
+- lib/tesco_rb/item.rb
+- lib/tesco_rb/item_requester.rb
+- lib/tesco_rb/representation_helper.rb
+- lib/tesco_rb/store.rb
+- lib/tesco_rb/store_requester.rb
+- lib/tesco_rb/version.rb
+- tesco_rb.gemspec
+homepage: https://github.com/wmmc/tesco_rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.0
+signing_key: 
+specification_version: 4
+summary: A wrapper to the Tesco API
+test_files: []