magento 0.24.0 → 0.28.0

data/spec/magento/core/model_spec.rb

@@ -0,0 +1,71 @@
+RSpec.describe Magento::Model do
+  describe 'public method' do
+    describe '.find' do
+      it 'is pending'
+    end
+
+    describe '.create' do
+      it 'is pending'
+    end
+
+    describe '.update' do
+      it 'is pending'
+    end
+
+    describe '.delete' do
+      it 'is pending'
+    end
+
+    describe '#save' do
+      it 'calls the update class method'
+    end
+
+    describe '#update' do
+      it 'calls the update class method'
+    end
+
+    describe '#delete' do
+      it 'calls the delete class method'
+    end
+
+    describe '.api_resource' do
+      it 'is pending'
+    end
+
+    describe '.entity_name' do
+      it 'is pending'
+    end
+
+    describe '.primary_key' do
+      it 'is pending'
+    end
+
+    describe 'delegated methods from query' do
+      it 'respond to .all'
+      it 'respond to .find_each'
+      it 'respond to .page'
+      it 'respond to .per'
+      it 'respond to .page_size'
+      it 'respond to .order'
+      it 'respond to .select'
+      it 'respond to .where'
+      it 'respond to .first'
+      it 'respond to .find_by'
+      it 'respond to .count'
+    end
+  end
+
+  describe 'protected method' do
+    describe '.entity_key' do
+      it 'is pending'
+    end
+
+    describe '.query' do
+      it 'is pending'
+    end
+
+    describe '.request' do
+      it 'is pending'
+    end
+  end
+end

data/spec/magento/core/query_spec.rb

@@ -0,0 +1,207 @@
+class Magento::Faker < Magento::Model; end
+
+RSpec.describe Magento::Query do
+  subject { Magento::Query.new(Magento::Faker) }
+
+  describe '#where' do
+    it 'add the filter to group of filters' do
+      subject.where(price_gt: 50)
+
+      expect(subject.send(:filter_groups)).to eql([
+        { filters: [{ field: 'price', conditionType: 'gt', value: 50 }] }
+      ])
+    end
+
+    context 'when the condition is not passed' do
+      it 'the "eq" condition is used as default' do
+        subject.where(price: 50)
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: :price, conditionType: 'eq', value: 50 }] }
+        ])
+      end
+    end
+
+    context 'when it is called more than once' do
+      it 'adds filter in diferent groups' do
+        subject.where(price_gt: 10).where(price_lt: 20)
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: 'price', conditionType: 'gt', value: 10 }] },
+          { filters: [{ field: 'price', conditionType: 'lt', value: 20 }] }
+        ])
+      end
+    end
+
+    context 'when it is called with more than one filter' do
+      it 'adds the filters in same group' do
+        subject.where(price_gt: 10, price_lt: 20)
+
+        expect(subject.send(:filter_groups)).to eql([
+          {
+            filters: [
+              { field: 'price', conditionType: 'gt', value: 10 },
+              { field: 'price', conditionType: 'lt', value: 20 }
+            ]
+          }
+        ])
+      end
+    end
+
+    context 'when the condition is "in" or "nin" and value is a Array' do
+      it 'converts the value to string' do
+        subject.where(status_in: [:pending, :new])
+        subject.where(entity_id_nin: [123, 321])
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: 'status', conditionType: 'in', value: 'pending,new' }] },
+          { filters: [{ field: 'entity_id', conditionType: 'nin', value: '123,321' }] }
+        ])
+      end
+    end
+  end
+
+  describe '#page' do
+    it do
+      subject.page(2)
+      expect(subject.send(:current_page)).to eql(2)
+    end
+  end
+
+  describe '#page_size' do
+    it do
+      subject.page_size(5)
+      expect(subject.instance_variable_get(:@page_size)).to eql(5)
+    end
+  end
+
+  describe '#select' do
+    it 'set fields inside items[]' do
+      subject.select(:id, :name)
+
+      expect(subject.send(:fields)).to eql('items[id,name],search_criteria,total_count')
+    end
+
+    it 'allow hash' do
+      subject.select(:id, nested_attribute: :name)
+
+      expect(subject.send(:fields)).to eql('items[id,nested_attribute[name]],search_criteria,total_count')
+    end
+
+    it 'allow hash with key and value as array' do
+      subject.select(:id, nested_attribute: [:id, :name])
+
+      expect(subject.send(:fields)).to eql('items[id,nested_attribute[id,name]],search_criteria,total_count')
+    end
+
+    it 'allow hash multiple level' do
+      subject.select(:id, nested_attribute: [:id, :name, stock: :quantity])
+
+      expect(subject.send(:fields)).to eql(
+        'items[id,nested_attribute[id,name,stock[quantity]]],search_criteria,total_count'
+      )
+    end
+
+    context 'when model is Magento::Category' do
+      class Magento::Category < Magento::Model; end
+
+      subject { Magento::Query.new(Magento::Category) }
+
+      it 'set fields inseide children_data[]' do
+        subject.select(:id, :name)
+
+        expect(subject.send(:fields)).to eql('children_data[id,name]')
+      end
+    end
+  end
+
+  describe '#order' do
+    it 'set order in sort_orders' do
+      subject.order(name: :desc)
+
+      expect(subject.send(:sort_orders)).to eql(
+        [{ field: :name, direction: :desc }]
+      )
+
+      subject.order(created_at: :desc, name: :asc)
+
+      expect(subject.send(:sort_orders)).to eql(
+        [
+          { field: :created_at, direction: :desc },
+          { field: :name, direction: :asc }
+        ]
+      )
+    end
+
+    context 'when the direction is not passed' do
+      it 'the :asc direction is used as default' do
+        subject.order(:name)
+
+        expect(subject.send(:sort_orders)).to eql(
+          [{ field: :name, direction: :asc }]
+        )
+
+        subject.order(:created_at, :name)
+
+        expect(subject.send(:sort_orders)).to eql([
+          { field: :created_at, direction: :asc },
+          { field: :name, direction: :asc }
+        ])
+      end
+    end
+  end
+
+  describe '#all' do
+    it 'is pending'
+  end
+
+  describe '#first' do
+    it 'is pending'
+  end
+
+  describe '#find_by' do
+    it 'is pending'
+  end
+
+  describe '#count' do
+    it 'is pending'
+  end
+
+  describe '#find_each' do
+    it 'is pending'
+  end
+
+  describe 'private mathods' do
+    describe 'endpoint' do
+      it 'is pending'
+    end
+
+    describe 'verify_id' do
+      it 'is pending'
+    end
+
+    describe 'query_params' do
+      it 'is pending'
+    end
+
+    describe 'parse_filter' do
+      it 'is pending'
+    end
+
+    describe 'parse_value_filter' do
+      it 'is pending'
+    end
+
+    describe 'parse_field' do
+      it 'is pending'
+    end
+
+    describe 'encode' do
+      it 'is pending'
+    end
+
+    describe 'append_key' do
+      it 'is pending'
+    end
+  end
+end

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