spree_devices 1.2.0

data/lib/spree_devices.rb

@@ -0,0 +1,5 @@
+## REQUIRE DEPENDENCIES
+require 'spree_core'
+
+## REQUIRE GEM FILES
+require 'spree_devices/engine'

data/lib/spree_devices/engine.rb

@@ -0,0 +1,31 @@
+module SpreeDevices
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_devices'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+
+  def self.setup(&block)
+    @config ||= SpreeDevices::Engine::Configuration.new
+    yield @config if block
+
+    @config
+  end
+
+  def self.config
+    Rails.application.config
+  end
+end

data/lib/spree_devices/engine_factories/device_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :device, class: Spree::Device do
+    name 'device_name'
+    uid { FFaker::Guid.unique.guid }
+  end
+end

data/lib/spree_devices/engine_factories/user_device_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :user_device, class: Spree::UserDevice do
+    user
+    device
+  end
+end

data/lib/spree_devices/factories.rb

@@ -0,0 +1,5 @@
+require 'factory_bot'
+
+Dir["#{File.dirname(__FILE__)}/engine_factories/**"].each do |f|
+  load File.expand_path(f)
+end

data/spec/api/v1/devices_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe 'API', type: :request do
+  include DevicesAPISupport
+
+  describe 'POST /api/v1/devices' do
+    before :each do
+      @user = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+      @headers = request_headers(@user)
+    end
+
+    it 'registers new user device' do
+      device_name = 'iPhone 6'
+      uid = FFaker::Guid.guid
+
+      post '/api/v1/devices', params: { name: device_name, uid: uid }.to_json, headers: @headers
+
+      expect(status).to eq 200
+      device = Spree::Device.where(name: device_name, uid: uid).first
+      expect(device).not_to be_nil
+      expect(Spree::UserDevice.where(device: device, user: @user).first).not_to be_nil
+    end
+
+    it 'registers existing user device' do
+      max_number_of_devices = SpreeDevices.config.try(:max_number_of_devices) || 3
+
+      device = nil
+      max_number_of_devices.times do
+        device = create(:device)
+        create(:user_device, user: @user, device: device)
+      end
+
+      post '/api/v1/devices', params: { name: device.name, uid: device.uid }.to_json, headers: @headers
+
+      expect(status).to eq 200
+      expect(Spree::Device.count).to eq max_number_of_devices
+      expect(Spree::UserDevice.where(user: @user).count).to eq max_number_of_devices
+    end
+
+    context 'when device limit is reached' do
+      it 'blocks registering the device' do
+        device_name = 'iPhone 6'
+        uid = FFaker::Guid.guid
+        max_number_of_devices = SpreeDevices.config.try(:max_number_of_devices) || 3
+
+        max_number_of_devices.times do
+          create(:user_device, user: @user, device: create(:device))
+        end
+
+        post '/api/v1/devices', params: { name: device_name, uid: uid }.to_json, headers: @headers
+
+        expect(status).to eq 422
+        parsed_response = JSON.parse(response.body)
+        expect(parsed_response['error']).not_to be_nil
+        expect(parsed_response['errors']['device']).not_to be_nil
+        expect(Spree::Device.count).to eq max_number_of_devices
+        expect(Spree::UserDevice.where(user: @user).count).to eq max_number_of_devices
+      end
+    end
+
+    context 'when device is missing parameters' do
+      it 'blocks registering the device' do
+        device = create(:device)
+        create(:user_device, user: @user, device: device)
+
+        post '/api/v1/devices', params: { name: nil, uid: nil }.to_json, headers: @headers
+
+        expect(status).to eq 422
+        parsed_response = JSON.parse(response.body)
+        expect(parsed_response['error']).not_to be_nil
+        expect(parsed_response['errors']['device']).not_to be_nil
+        expect(Spree::Device.count).to eq 1
+        expect(Spree::UserDevice.where(user: @user).count).to eq 1
+      end
+    end
+
+    context 'when multiple users has the same device' do
+      it 'registers same user device' do
+        user1 = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+        user2 = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+        user3 = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+        device = create(:device)
+
+        create(:user_device, user: user1, device: device)
+        create(:user_device, user: user2, device: device)
+        create(:user_device, user: user3, device: device)
+
+        post '/api/v1/devices', params: { name: device.name, uid: device.uid }.to_json, headers: @headers
+
+        expect(status).to eq 200
+        expect(Spree::Device.count).to eq 1
+        expect(Spree::UserDevice.count).to eq 4
+      end
+    end
+  end
+end

data/spec/api/v1/products_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'API', type: :request do
+  include DevicesAPISupport
+
+  describe 'GET /api/v1/products' do
+    before :each do
+      @user = create(:user, email: 'test@ingemark.com', password: 'password')
+      @user.generate_spree_api_key!
+      @device = create(:device)
+      create(:user_device, user: @user, device: @device)
+    end
+
+    context 'when valid device name and uid headers are provided' do
+      it 'lists protected resource' do
+        headers = request_headers_with_device(@user, @device)
+
+        get '/api/v1/products', params: {}, headers: headers
+        expect(status).to eq 200
+      end
+    end
+
+    context 'when invalid device name and uid headers are provided' do
+      it 'does not list protected resource' do
+        unused_device = create(:device)
+        headers = request_headers_with_device(@user, unused_device)
+
+        get '/api/v1/products', params: {}, headers: headers
+        expect(status).to eq 401
+      end
+    end
+  end
+end

data/spec/controllers/devices_controller_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Spree::DevicesController, type: :controller do
+  context 'when there are 3 user devices' do
+    before :each do
+      user = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+      allow(controller).to receive(:spree_current_user).and_return(user)
+      device1 = create(:device)
+      device2 = create(:device)
+      device3 = create(:device)
+      @user_device1 = create(:user_device, user: user, device: device1)
+      @user_device2 = create(:user_device, user: user, device: device2)
+      @user_device3 = create(:user_device, user: user, device: device3)
+    end
+
+    it 'lists user devices' do
+      get :index
+
+      expect(response.status).to eq 200
+      expect(response).to render_template('index')
+    end
+
+    it 'deletes user device' do
+      delete :destroy, params: { id: @user_device3.device.id }
+
+      expect(response.status).to eq 302
+      expect(response).to redirect_to(devices_url)
+      expect(Spree::Device.count).to eq 2
+      expect(Spree::UserDevice.count).to eq 2
+    end
+  end
+
+  context 'when there are two users on the same device' do
+    it 'deletes user device' do
+      user1 = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+      user2 = create(:user, email: FFaker::Internet.email, password: FFaker::Internet.password)
+      allow(controller).to receive(:spree_current_user).and_return(user1)
+      device = create(:device)
+      user_device1 = create(:user_device, user: user1, device: device)
+      create(:user_device, user: user2, device: device)
+
+      delete :destroy, params: { id: user_device1.device.id }
+
+      expect(response.status).to eq 302
+      expect(response).to redirect_to(devices_url)
+      expect(Spree::Device.count).to eq 1
+      expect(Spree::UserDevice.count).to eq 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+# Run Coverage report
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('dummy/config/environment.rb', __dir__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/spree_devices/factories.rb
+require 'spree_devices/factories'
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Requests support
+  #
+  # Adds convenient methods to request Spree's controllers
+  # spree_get :index
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using
+  # database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = 'random'
+
+  config.include Warden::Test::Helpers
+end

data/spec/support/devices_api.rb

@@ -0,0 +1,22 @@
+module DevicesAPISupport
+  def request_headers(user)
+    user.generate_spree_api_key!
+    {
+      'X-Spree-Token' => user.spree_api_key,
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
+    }
+  end
+
+  def request_headers_with_device(user, device)
+    user.generate_spree_api_key!
+    {
+      'X-Spree-Token' => user.spree_api_key,
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json',
+      'Device-Name' => device.name,
+      'Device-Uid' => device.uid,
+      'X-OS' => 'iOS'
+    }
+  end
+end

data/spec/utils/rubocop_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rubocop'
+
+describe 'Rubocop', level: 'technical' do
+  it 'should pass' do
+    expect(RuboCop::CLI.new.run([])).to eq(0)
+  end
+end

data/spree_devices.gemspec

@@ -0,0 +1,26 @@
+# require_relative 'core/lib/spree/core/version.rb'
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_devices'
+  s.version     = '1.2.0'
+  s.summary     = ''
+  s.description = ''
+  s.required_ruby_version = '>= 2.4.1'
+
+  s.author       = 'Matej Minažek'
+  s.email        = 'matej.minazek@ingemark.com'
+  s.homepage     = 'http://ingemark.com'
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_runtime_dependency 'spree_api', ['>= 3.1.0', '<4.0']
+  s.add_runtime_dependency 'spree_core', ['>= 3.1.0', '<4.0']
+
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'poltergeist'
+  s.add_development_dependency 'sass-rails'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: spree_devices
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Matej Minažek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: matej.minazek@ingemark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Jenkinsfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_devices.js
+- app/assets/javascripts/spree/frontend/spree_devices.js
+- app/assets/stylesheets/spree/backend/spree_devices.css
+- app/assets/stylesheets/spree/frontend/spree_devices.css
+- app/controllers/spree/api/base_controller_decorator.rb
+- app/controllers/spree/api/v1/devices_controller.rb
+- app/controllers/spree/devices_controller.rb
+- app/models/spree/device.rb
+- app/models/spree/user_decorator.rb
+- app/models/spree/user_device.rb
+- app/overrides/spree/users/show/add_devices_to_account_my_orders.html.erb.deface
+- app/services/spree/device_service.rb
+- app/views/spree/api/v1/devices/index.v1.rabl
+- app/views/spree/api/v1/devices/show.v1.rabl
+- app/views/spree/api/v1/shared/error.v1.rabl
+- app/views/spree/devices/index.html.erb
+- bin/rails
+- config/locales/ar.yml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20160317153123_create_devices.rb
+- db/migrate/20160317154122_create_user_devices.rb
+- db/migrate/20160321135103_rename_device_code_to_device_uid.rb
+- db/migrate/20160511093138_rename_devices_tables.rb
+- lib/generators/spree_devices/install/install_generator.rb
+- lib/spree_devices.rb
+- lib/spree_devices/engine.rb
+- lib/spree_devices/engine_factories/device_factory.rb
+- lib/spree_devices/engine_factories/user_device_factory.rb
+- lib/spree_devices/factories.rb
+- spec/api/v1/devices_spec.rb
+- spec/api/v1/products_spec.rb
+- spec/controllers/devices_controller_spec.rb
+- spec/spec_helper.rb
+- spec/support/devices_api.rb
+- spec/utils/rubocop_spec.rb
+- spree_devices.gemspec
+homepage: http://ingemark.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []