tesco_rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b25b0f2276329359cb2fcb0ea97b1a50467d7daa
-  data.tar.gz: 56f845caee7bf60a4f4b56ffe6405359b8960d1c
+  metadata.gz: fcff709eff851b88df22d6cc9624d5eae18a604e
+  data.tar.gz: 4e04e3a4673b7a745e349d12a346e8e6f5225a92
 SHA512:
-  metadata.gz: ff8709a6d91996bbd0fb0b75f98c3f9c842e03f1daadfef25c4007aa70639fb51f0a81ecfbfa773dd2bd4d1b415b9fa96f1fea96d7ae867aa4833297cc70d798
-  data.tar.gz: bdc43d6321a9ed18ce35238da811e8dd7c9f88bc0a924dcdd45ef1b98f7a73acc6c5531d0abfb3b573dc8aa8531db7c33553745bc17ae454f77ba0aa40639b5b
+  metadata.gz: 43fd8bd7d29e112fcb4b86db4e1617ce60faa35c24c9f824a6bcd240c3713d312b55eb8cdcad08b90f0c1087a9e765ee14ed0585581f2414edf2f0336ce08c45
+  data.tar.gz: 52d4822369f269367f5cc0461c5f15a6b16de1f59602fb79296be4b669299b52267e1e95db29ef2c816fc7eac6613865c09fe2cfa5db67abd36048380f2aa589

data/README.org

@@ -1,4 +1,8 @@
 * TescoRb
+A ruby gem for interacting with the [[https://devportal.tescolabs.com/docs/services/][Tesco Api]].
+Currently it supports [[https://devportal.tescolabs.com/docs/services/56c73b1bf205fd0ed81dbe7a][Grocery]] & [[https://devportal.tescolabs.com/docs/services/5731ed21611a4b2968547c5f][Store Location]] end points.
+
+
 ** Usage Examples:
 
 #+BEGIN_SRC ruby
@@ -35,8 +39,13 @@ $ bundle
 $ gem install tesco_rb
 #+END_SRC
 
-
-*** Todos
-    - `client.item.search('bananas')` syntax; add `.search` method
+*** Todo
+    - ~client.item.search('bananas')~ syntax; add ~.search~ method
       - This would involve creating new 'items' holding class (currently just an Array)
     - DRY / subclass requesters
+    - Sort out travis CI
+    - More examples about returned objects??
+    - OpeningHours Object
+    - GeoLocation Object
+    - Get rid of linting errors
+    - Think about exceptions / error handling

data/Rakefile

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

data/lib/tesco_rb/client.rb

@@ -1,5 +1,5 @@
-require 'tesco_rb/store_requester'
-require 'tesco_rb/item_requester'
+require_relative 'store_requester'
+require_relative 'item_requester'
 require 'httparty'
 
 module TescoRb
@@ -11,6 +11,7 @@ module TescoRb
     base_uri 'https://dev.tescolabs.com/'
 
     def initialize(api_key)
+      fail 'invalid API Key' unless api_key.is_a?(String) && api_key.length > 10
       @api_key = api_key
     end
 
@@ -28,7 +29,7 @@ module TescoRb
 
     def default_options
       { headers:
-          { 'Ocp-Apim-Subscription-Key' => ENV['TESCO_API_KEY'] } }
+          { 'Ocp-Apim-Subscription-Key' => api_key } }
     end
   end
 end

data/lib/tesco_rb/item_requester.rb

@@ -9,8 +9,6 @@ module TescoRb
       products.map do |json|
         Item.new(json)
       end
-    rescue => e
-      p e
     end
 
     private
@@ -23,15 +21,6 @@ module TescoRb
 
     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

data/lib/tesco_rb/store.rb

@@ -31,8 +31,5 @@ module TescoRb
       end
     end
 
-    # def set_fields
-    #   fields.each { |field| attr_reader field }
-    # end
   end
 end

data/lib/tesco_rb/store_requester.rb

@@ -4,10 +4,9 @@ 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|
+      # Raise Errors here?
+      return [] unless response['results']
+      response['results'].map do |json|
         Store.new(json.fetch('location'))
       end
     end
@@ -24,15 +23,6 @@ module TescoRb
 
     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

data/lib/tesco_rb/version.rb

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

data/lib/tesco_rb.rb

@@ -1,12 +1,12 @@
-require "tesco_rb/version"
-require "tesco_rb/client"
-require "tesco_rb/store"
-require "tesco_rb/store_requester"
-require "tesco_rb/representation_helper"
+require_relative 'tesco_rb/version'
+require_relative 'tesco_rb/client'
+# require_relative 'tesco_rb/store'
+# require_relative 'tesco_rb/store_requester'
+# require_relative 'tesco_rb/representation_helper'
 
-# Wrapper for the tescolabs api:
-# https://devportal.tescolabs.com/docs/services
-
-# module TescoRb
-#   # Your code goes here...
-# end
+# The entry point to this gem: TescoRb.new(API_KEY)
+module TescoRb
+  def self.new(api_key)
+    Client.new(api_key)
+  end
+end

data/tesco_rb.gemspec

@@ -10,13 +10,15 @@ Gem::Specification.new do |spec|
   spec.email         = ['wmmclarke@gmail.com']
 
   spec.summary       = 'A wrapper to the Tesco API'
+  spec.description   = 'Navigate the Tesco API: https://devportal.tescolabs.com/docs/services/'
+
   spec.homepage      = 'https://github.com/wmmc/tesco_rb'
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    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|
@@ -29,11 +31,10 @@ Gem::Specification.new do |spec|
   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 'pry-byebug', '~> 3.4', '>= 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'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency 'dotenv', '~> 2.1', '>= 2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tesco_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - William Clarke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-20 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -43,6 +43,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
@@ -50,6 +53,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
@@ -85,6 +91,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
   type: :development
@@ -92,6 +101,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
 - !ruby/object:Gem::Dependency
@@ -99,6 +111,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
@@ -106,6 +121,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
@@ -113,6 +131,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.1
   type: :development
@@ -120,9 +141,12 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.1
-description: 
+description: 'Navigate the Tesco API: https://devportal.tescolabs.com/docs/services/'
 email:
 - wmmclarke@gmail.com
 executables: []