magento 0.26.1 → 0.27.0

data/spec/magento/core/record_collection_spec.rb

@@ -0,0 +1,116 @@
+RSpec.describe Magento::RecordCollection do
+  subject { Magento::RecordCollection.new(items: []) }
+
+  describe 'read only attributes' do
+    it { is_expected.to respond_to(:items) }
+    it { is_expected.to respond_to(:search_criteria) }
+    it { is_expected.to respond_to(:total_count) }
+    it { is_expected.not_to respond_to(:items=) }
+    it { is_expected.not_to respond_to(:search_criteria=) }
+    it { is_expected.not_to respond_to(:total_count=) }
+  end
+
+  describe '#last_page?' do
+    it do
+      subject = create_subject_with_pagination(total_count: 60, current_page: 6, page_size: 10)
+      expect(subject.last_page?).to be true
+    end
+
+    it do
+      subject = create_subject_with_pagination(total_count: 60, current_page: 5, page_size: 10)
+      expect(subject.last_page?).to be false
+    end
+  end
+
+  describe '#next_page' do
+    it 'returns next page number' do
+      subject = create_subject_with_pagination(current_page: 5, total_count: 60, page_size: 10)
+      expect(subject.next_page).to be 6
+    end
+
+    it 'returns nil when current page is the last' do
+      subject = create_subject_with_pagination(current_page: 6, total_count: 60, page_size: 10)
+      expect(subject.next_page).to be nil
+    end
+  end
+
+  describe '.from_magento_response' do
+    let(:response) do
+      {
+        'items' => [
+          { 'id' => 1, 'name' => 'Product one' },
+          { 'id' => 2, 'name' => 'Product two' }
+        ],
+        'total_count' => 12,
+        'search_criteria' => { 'current_page' => 2, 'page_size' => 10 }
+      }
+    end
+
+    it 'create RecordCollection instance from magento response' do
+      records = Magento::RecordCollection.from_magento_response(response, model: Magento::Product)
+
+      expect(records).to all be_a_instance_of(Magento::Product)
+      expect(records.size).to eql(2)
+      expect(records.total_count).to eql(12)
+    end
+
+    it 'allows specify the iterable field' do
+      response['data'] = response.delete 'items'
+
+      records = Magento::RecordCollection.from_magento_response(
+        response, 
+        model: Magento::Product,
+        iterable_field: 'data'
+      )
+
+      expect(records.size).to eql(2)
+      expect(records).to all be_a_instance_of(Magento::Product)
+    end
+  end
+
+  describe 'delegated methods' do
+    let(:methods) do
+      %i[
+        count
+        length
+        size
+        first
+        last
+        []
+        find
+        each
+        each_with_index
+        sample
+        map
+        select
+        filter
+        reject
+        collect
+        take
+        take_while
+        sort
+        sort_by
+        reverse_each
+        reverse
+        all?
+        any?
+        none?
+        one?
+        empty?
+      ]
+    end
+
+    it 'from #items' do
+      methods.each do |method|
+        expect(subject).to respond_to(method)
+        expect(subject.items).to receive(method)
+        subject.send(method)
+      end
+    end
+  end
+
+  def create_subject_with_pagination(total_count:, current_page:, page_size:)
+    search_criteria = double(:search_criteria, current_page: current_page, page_size: page_size)
+    Magento::RecordCollection.new(items: [], total_count: total_count, search_criteria: search_criteria)
+  end
+end

data/spec/magento/core/request_spec.rb

@@ -0,0 +1,141 @@
+RSpec.describe Magento::Request do
+  let(:config) do
+    double('Magento::Configuration',
+      url: 'https://site.com.br',
+      token: 'magento-token',
+      store: 'magento-store',
+      timeout: 30,
+      open_timeout: 5
+    )
+  end
+
+  subject { Magento::Request.new(config: config) }
+
+  let(:response) do
+    double('Response', parse: {}, status: double(:status, success?: true))
+  end
+
+  describe '#get' do
+    it 'calls HTTP.get with url' do
+      expect_any_instance_of(HTTP::Client).to receive(:get)
+        .with('https://site.com.br/rest/magento-store/V1/products')
+        .and_return(response)
+
+      subject.get('products')
+    end
+  end
+
+  describe '#put' do
+    it 'calls HTTP.put with url and body' do
+      body = { product: { price: 22.50 } }
+
+      expect_any_instance_of(HTTP::Client).to receive(:put)
+        .with('https://site.com.br/rest/magento-store/V1/products', { json: body })
+        .and_return(response)
+
+      subject.put('products', body)
+    end
+  end
+
+  describe '#post' do
+    it 'calls HTTP.post with url and body' do
+      body = { product: { name: 'Some name', price: 22.50 } }
+
+      expect_any_instance_of(HTTP::Client).to receive(:post)
+        .with('https://site.com.br/rest/magento-store/V1/products', { json: body })
+        .and_return(response)
+
+      subject.post('products', body)
+    end
+  end
+
+  describe '#delete' do
+    it 'calls HTTP.selete with url' do
+      expect_any_instance_of(HTTP::Client).to receive(:delete)
+        .with('https://site.com.br/rest/magento-store/V1/products/22')
+        .and_return(response)
+
+      subject.delete('products/22')
+    end
+  end
+
+  context 'private method' do
+    describe '#http_auth' do
+      it 'calls HTTP.auth with token and returns HTTP::Client' do
+        expect(HTTP).to receive(:auth).with("Bearer #{config.token}").and_return(HTTP)
+        result = subject.send(:http_auth)
+        expect(result).to be_a(HTTP::Client)
+      end
+    end
+
+    describe '#base_url' do
+      it do
+        base_url = "https://site.com.br/rest/magento-store/V1"
+        expect(subject.send(:base_url)).to eql(base_url)
+      end
+    end
+
+    describe '#url' do
+      it 'returns base_url + resource' do
+        url = "https://site.com.br/rest/magento-store/V1/products"
+        expect(subject.send(:url, 'products')).to eql(url)
+      end
+    end
+
+    describe '#handle_error' do
+      context 'when success' do
+        it 'does nothing' do
+          subject.send(:handle_error, response)
+        end
+      end
+
+      context 'when status not found' do
+        it 'reises Magento::NotFound error' do
+          allow(response).to receive(:status).and_return(
+            double(:status, success?: false, not_found?: true, code: 404)
+          )
+
+          expect { subject.send(:handle_error, response) }.to raise_error(Magento::NotFound)
+        end
+      end
+
+      context 'when other status' do
+        it 'reises Magento::MagentoError' do
+          allow(response).to receive(:status).and_return(
+            double(:status, success?: false, not_found?: false, code: 422)
+          )
+
+          expect { subject.send(:handle_error, response) }.to raise_error(Magento::MagentoError)
+        end
+      end
+    end
+
+    describe '#save_request' do
+      it 'save on instance variable' do
+        body = { quantity: 200, category_ids: [1,3,4] }
+
+        subject.send(:save_request, :post, 'https:someurl.com.br', body)
+
+        expect(subject.instance_variable_get(:@request)).to eql({
+          body: body,
+          method: :post,
+          url: 'https:someurl.com.br',
+        })
+      end
+
+      context 'when body has media_gallery_entries' do
+        it 'removes media_gallery_entries attribute from body' do
+          body = { product: { name: 'Name', price: 99.90, media_gallery_entries: {} } }
+
+          subject.send(:save_request, :post, 'https:someurl.com.br', body)
+
+          expect(subject.instance_variable_get(:@request)).to eql({
+            body: { name: 'Name', price: 99.90 },
+            method: :post,
+            url: 'https:someurl.com.br',
+          })
+        end
+      end
+    end
+  end
+end

data/spec/magento/order_spec.rb

@@ -1,38 +1,37 @@
-class RequestMock
-  attr_reader :path
-
-  def post(path)
-    @path = path
-    OpenStruct.new(success?: true, parse: true)
-  end
-end
-
 RSpec.describe Magento::Order do
-  before { Magento.url = 'https://site.com' }
+  let(:magento_client) { request = Magento::Request.new }
 
-  describe '.send_email' do
-    it 'shuld request POST /orders/:id/emails' do
-      request = RequestMock.new
-      allow(Magento::Order).to receive(:request).and_return(request)
-
-      order_id = 25
-      result = Magento::Order.send_email(order_id)
-
-      expect(request.path).to eql("orders/#{order_id}/emails")
-      expect(result).to be true
-    end
+  before do
+    allow(Magento::Order).to receive(:request).and_return(magento_client)
   end
 
-  describe '#send_email' do
-    it 'shuld request POST /orders/:id/emails' do
-      request = RequestMock.new
-      allow(Magento::Order).to receive(:request).and_return(request)
+  describe 'send_email' do
+    let(:order_id) { 11735 }
+    let(:response) { double('Response', parse: true, status: 200) }
+
+    describe 'class method' do
+      it 'should request POST /orders/:id/emails' do
+        expect(magento_client).to receive(:post)
+          .with("orders/#{order_id}/emails")
+          .and_return(response)
+  
+        result = Magento::Order.send_email(order_id)
+      end
+
+      it 'should return true' do
+        VCR.use_cassette('order/send_email') do
+          expect(Magento::Order.send_email(order_id)).to be(true).or be(false)
+        end
+      end
+    end
 
-      order = Magento::Order.build(id: 25)
-      result = order.send_email
+    describe 'instance method' do
+      it 'shuld call the class method with order_id' do
+        expect(Magento::Order).to receive(:send_email).with(order_id)
 
-      expect(request.path).to eql("orders/25/emails")
-      expect(result).to be true
+        order = Magento::Order.build(id: order_id)
+        result = order.send_email
+      end
     end
   end
 end

data/spec/{product_spec.rb → magento/product_spec.rb}

@@ -1,4 +1,25 @@
 RSpec.describe Magento::Product do
+  let(:magento_client) { Magento::Request.new }
+
+  before { allow(Magento::Product).to receive(:request).and_return(magento_client) }
+
+  describe '.find' do
+    it 'request to /prducts/:sku' do
+      response = double('HTTP::Response', parse: {})
+
+      expect(magento_client).to receive(:get).with('products/1243').and_return(response)
+
+      Magento::Product.find('1243')
+    end
+
+    it 'returns a Magento::Product instance' do
+      VCR.use_cassette('product/find') do
+        product = Magento::Product.find('1243')
+        expect(product).to be_an_instance_of(Magento::Product)
+      end
+    end
+  end
+
   describe '#set_custom_attribute' do
     let(:product) { Magento::Product.build(
       sku: 25,

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
-require "bundler/setup"
+require 'bundler/setup'
 require 'byebug'
-require "magento"
+require 'magento'
+require 'vcr'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+  config.example_status_persistence_file_path = '.rspec_status'
 
   # Disable RSpec exposing methods globally on `Module` and `main`
   config.disable_monkey_patching!
@@ -13,3 +14,16 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 end
+
+Magento.configure do |config|
+  config.url = 'https://dev.superbomemcasa.com.br'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<MAGENTO_URL>') { Magento.configuration.url }
+  c.filter_sensitive_data('<MAGENTO_DOMAIN>') { Magento.configuration.url.sub(/^http(s)?:\/\//, '') }
+  c.filter_sensitive_data('<MAGENTO_TOKEN>') { Magento.configuration.token }
+end

data/spec/vcr_cassettes/order/send_email.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<MAGENTO_URL>/rest/all/V1/orders/11735/emails"
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <MAGENTO_TOKEN>
+      Connection:
+      - close
+      Host:
+      - "<MAGENTO_DOMAIN>"
+      User-Agent:
+      - http.rb/4.4.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 28 Jan 2021 02:19:28 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - close
+      Set-Cookie:
+      - PHPSESSID=2smb8fbfrh89ov5l6dsaog9ol3; expires=Thu, 28-Jan-2021 03:19:28 GMT;
+        Max-Age=3600; path=/; domain=<MAGENTO_DOMAIN>; secure; HttpOnly
+      - __cfduid=d6599c746d9235e60e31314f2c23603101611800368; expires=Sat, 27-Feb-21
+        02:19:28 GMT; path=/; domain=.superbomemcasa.com.br; HttpOnly; SameSite=Lax;
+        Secure
+      Vary:
+      - Accept-Encoding
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Cf-Cache-Status:
+      - DYNAMIC
+      Cf-Request-Id:
+      - 07e862ec7d0000f603b22c5000000001
+      Expect-Ct:
+      - max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
+      Report-To:
+      - '{"group":"cf-nel","max_age":604800,"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report?s=LcpIGCN14P04w%2B12%2BJip%2BoqrTEEJHVD5vP3%2FqWTDV843xCQbwKwwisiq23jbvZ0fOkDmTOxTTgA804Jq1CCnW9d3I14x%2BUGjfoosFZuRXzpxNONKefOyryVm4KckyBHTJSF1EtaW"}]}'
+      Nel:
+      - '{"max_age":604800,"report_to":"cf-nel"}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 61873a8d9b69f603-GRU
+    body:
+      encoding: UTF-8
+      string: 'false'
+  recorded_at: Thu, 28 Jan 2021 02:19:28 GMT
+recorded_with: VCR 6.0.0