Merge pull request #7 from creatubbles/269-warehouse-get-creation-403-retry-mechanism

269 warehouse get creation 403 retry mechanism

Author: andrejj

Gemfile

@@ -1,8 +1,18 @@
 source "https://rubygems.org"
 
+ruby '2.4.1'
+
 gemspec
 
 group :development do
   gem 'rake'
   gem 'rspec'
 end
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'webmock'
+  gem 'sinatra'
+  gem 'pry'
+end

Gemfile.lock

@@ -13,23 +13,38 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    coderay (1.1.1)
     concurrent-ruby (1.0.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     faraday (0.10.1)
       multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.4)
     i18n (0.8.0)
     jwt (1.5.6)
+    method_source (0.8.2)
     minitest (5.10.1)
     multi_json (1.12.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
+    mustermann (1.0.0)
     oauth2 (1.3.0)
       faraday (>= 0.8, < 0.11)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (2.0.5)
     rack (2.0.1)
+    rack-protection (2.0.0)
+      rack
     rake (11.2.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -44,17 +59,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    sinatra (2.0.0)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.0)
+      tilt (~> 2.0)
+    slop (3.6.0)
     thread_safe (0.3.5)
+    tilt (2.0.8)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   creatubbles!
+  pry
   rake
   rspec
+  sinatra
+  webmock
+
+RUBY VERSION
+   ruby 2.4.1p111
 
 BUNDLED WITH
-   1.14.3
+   1.15.3

lib/creatubbles.rb

@@ -42,6 +42,7 @@ def self.instantiate_objects_from_response(response, connection)
 
 end
 
+require "creatubbles/error"
 require "creatubbles/utils/auth_details"
 require "creatubbles/content"
 require "creatubbles/contents"

lib/creatubbles/base_collection.rb

@@ -16,6 +16,18 @@ def initialize(connection)
   def find(id)
     res = @connection.get("#{self.class.type_name}/#{id}")
     Creatubbles.instantiate_object_from_response(res, @connection)
+  rescue => e
+    if is_record_not_found_404?(e)
+      raise Creatubbles::Error::RecordNotFound.new(e), "Not Found! #{self.class.type_name}/#{id}"
+    else
+      raise e
+    end
+  end
+
+  def find_by_id(id)
+    find(id)
+  rescue Creatubbles::Error::RecordNotFound
+    return nil
   end
 
   def init_objects(response)
@@ -26,4 +38,15 @@ def handle_params(params_hash={}, allowed_params=['query','filter'])
     params_hash.stringify_keys!.slice!(allowed_params).to_param
   end
 
+  private
+
+  def is_record_not_found_404?(e)
+    return false unless e.is_a?(OAuth2::Error)
+    body = e&.response&.body
+    return false unless body
+    resp = JSON.parse(e.response.body) rescue nil
+    return false unless resp
+    resp['errors'] && resp['errors'].any? { |err| err['status'].to_i == 404  }
+  end
+
 end

lib/creatubbles/error.rb

@@ -0,0 +1,11 @@
+module Creatubbles
+  module Error
+    #Creatubbles::Error::RecordNotFound
+    class RecordNotFound < StandardError
+      attr_reader :original
+      def initialize original
+        @original = original
+      end
+    end
+  end
+end

spec/creatubbles/base_collection_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Creatubbles::BaseCollection do
+
+  it "ignores deleted creation" do
+    client = Creatubbles::Client.dummy
+
+    expect{client.test_objects.find('non-existing-object-id')}.
+      to raise_error(Creatubbles::Error::RecordNotFound)
+
+    begin
+      client.test_objects.find('non-existing-object-id')
+    rescue => e
+      expect(e.original).to be_a(OAuth2::Error)
+      expect(e.message).to include('non-existing-object-id')
+    end
+
+    expect(client.test_objects.find_by_id('non-existing-object-id')).
+      to be_nil
+  end
+end

spec/creatubbles/creation_spec.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require 'spec_helper'
 
 describe Creatubbles::Creation do
   let(:client) { Creatubbles::Client.new }

spec/creatubbles/user_spec.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require 'spec_helper'
 
 describe Creatubbles::User do
   let(:client) { Creatubbles::Client.new }

spec/helper.rb renamed to spec/spec_helper.rb

@@ -1,12 +1,21 @@
 require 'oauth2'
 require 'rspec'
 require 'creatubbles'
+require 'sinatra/base'
+require 'webmock/rspec'
+require 'pry'
 
 Dir['spec/support/**/*.rb'].each do |f|
   require f.gsub('spec/', '').gsub('.rb', '')
 end
 
+WebMock.disable_net_connect!(allow_localhost: true)
+
 RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:any, /api.creatubbles.com/).to_rack(Creatubbles::MockAPI)
+  end
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

spec/support/creatubbles_mock_api.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Creatubbles
+  class MockAPI < Sinatra::Base
+    set :port, 3000
+
+    # put class variables here
+    # you cannot use @var in Sinatra::Base
+    configure do
+    end
+
+    # return a preset access token
+    post '/oauth/token' do
+      headers "Content-Type" => 'application/json'
+      {"access_token" => "a8c814aa3cee2d5cdca997a314dca206335c119e7121e954a7c6f17592caa33d", "token_type" => "bearer", "created_at" => 1479918313}.to_json
+    end
+
+    post '/v2/oauth/token' do
+      headers "Content-Type" => 'application/json'
+      {"access_token" => "a8c814aa3cee2d5cdca997a314dca206335c119e7121e954a7c6f17592caa33d", "token_type" => "bearer", "created_at" => 1479918313}.to_json
+    end
+
+    # get a non existing object
+    get '/v2/test_objects/non-existing-object-id' do
+      status 404
+      headers "Content-Type" => 'application/json'
+      "{\"errors\":[{\"status\":\"404\",\"code\":\"not_found\",\"source\":\"https://api.creatubbles.com/v2/objects/non-existing-creation-id\",\"title\":\"Not found\",\"detail\":\"Record not found\"}]}"
+    end
+
+  end
+end
+
+# To run the moch as a separate process:
+# Creatubbles::MockAPI.run!