prestashopper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb45387162f612a1a13f6fddc9aa76fe44439c7d
+  data.tar.gz: f9cbe7668eeae82ca4aab0d8a8b53f86f99693ab
+SHA512:
+  metadata.gz: fe784e19c467bbb8d600fe7a53634584a45bfa538207d485468f20d35d89116f099f3b438d62828343458215fb35d7e6b944257714f7d308a8a3587054c4190a
+  data.tar.gz: 6902fa4d21968891c88db3450b4868741a2d690d8f4d75a795936529020931285a711721908f99f170de1f4fbdb7cbed016ffca1668d0607157ab0b418163101

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (August 12, 2016)
+
+Features: 
+
+- check if the API is enabled for a Prestashop instance
+- check if an API key is valid for a Prestashop instance

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prestashopper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alfredo Amatriain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Prestashopper
+
+Prestashopper is a ruby gem to interact with a Prestashop API. It has been tested with Prestashop v1.6.1.2
+
+Prestashop is an open source e-commerce application written in PHP: [visit the homepage](https://www.prestashop.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prestashopper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prestashopper
+    
+## Enabling the Prestashop API and creating an API key
+
+For security reasons the Prestashop API is disabled by default. To be able to use this gem you will have to enable it.
+
+Once enabled you'll have to create an API key and give it the necessary permissions for the operations you intend to perform. Most methods in this gem need a valid API key.
+
+For more information about enabling the Prestashop API and managing API keys and their permissions, see the [official documentation](http://doc.prestashop.com/display/PS16/Using+the+PrestaShop+Web+Service).
+
+## Usage
+
+### Checking if the Prestashop API is enabled
+```
+Prestashopper.api_enabled? 'my.prestashop.com'
+=> true
+```
+
+### Checking if an API key is valid
+```
+Prestashopper.valid_key? 'my.prestashop.com', 'VALID_KEY'
+=> true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. The documentation can be generated from the yard comments running `yard doc`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/amatriain/prestashopper](https://github.com/amatriain/prestashopper).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'prestashopper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prestashopper.rb

@@ -0,0 +1,63 @@
+require 'prestashopper/version'
+require 'rest-client'
+require 'prestashopper/api'
+require 'prestashopper/uri_handler'
+
+# @author Alfredo Amatriain <geralt@gmail.com>
+#
+# Ruby gem for interacting with the Prestashop API.
+module Prestashopper
+
+  # Check if there is an enabled API in a Prestashop instance.
+  # @param url [String] base URL of the Prestashop installation. Do not append "/api" to it, the gem does it internally.
+  #   E.g. use "http://my.prestashop.com", not "http://my.prestashop.com/api"
+  # @return [boolean] true if the API is enabled, false if it is disabled
+  # @raise [RestClient::Exception] if there is an error during HTTP GET
+  # @raise [StandardError] if a response different from 401 or 503 is received (not counting redirect responses,
+  #   which will be followed)
+  def self.api_enabled?(url)
+    api_uri = UriHandler.api_uri url
+    res = RestClient::Resource.new api_uri, user: '', password: ''
+    begin
+      response = res.get
+      # We don't send an API key, so an HTTP error code should be returned. Execution shouldn't reach here normally.
+      raise StandardError.new "Expected 401 or 503 response from Prestashop API #{api_uri} without key, instead received <#{response.code}> #{response.body}"
+    rescue RestClient::Exception => e
+      if e.response.code == 401
+        return true # "Unauthorized" response means API is enabled
+      elsif e.response.code == 503
+        return false # "Service Unavailable" response means API is disabled
+      else
+        raise e # Any other HTTP error code means something is wrong
+      end
+    end
+  end
+
+  # Check if an API key is valid.
+  # @param url [String] base URL of the Prestashop installation. Do not append "/api" to it, the gem does it internally.
+  #   E.g. use "http://my.prestashop.com", not "http://my.prestashop.com/api"
+  # @param key [String] the key to check
+  # @return [boolean] true if key is valid, false otherwise
+  # @raise [RestClient::Exception] if there is an error during HTTP GET
+  # @raise [StandardError] if a response different from 200 or 401 is received (not counting redirect responses,
+  #   which will be followed)
+  def self.valid_key?(url, key)
+    api_uri = UriHandler.api_uri url
+    res = RestClient::Resource.new api_uri, user: key, password: ''
+    begin
+      response = res.get
+      if response.code == 200 # OK response means API key is valid
+        return true
+      else
+        raise StandardError.new "Expected 200 or 401 response from Prestashop API #{api_uri} with key #{key}, instead received <#{response.code}> #{response.body}"
+      end
+    rescue RestClient::Exception => e
+      if e.response.code == 401
+        return false # "Unauthorized" response means API key is invalid
+      else
+        raise e # Any other HTTP error code means something is wrong
+      end
+    end
+  end
+
+end

data/lib/prestashopper/api.rb

@@ -0,0 +1,7 @@
+module Prestashopper
+
+  # Each instance represents a Prestashop API instance.
+  class API
+
+  end
+end

data/lib/prestashopper/uri_handler.rb

@@ -0,0 +1,26 @@
+require 'uri'
+
+module Prestashopper
+
+  # Handle URIs, converting from base Prestashop URL to API URIs
+  class UriHandler
+    API_PATH = 'api/'
+
+    # Convert a base Prestashop URL to its API URI
+    # @param base_url [String] a Prestashop base URL. Do not append "/api", it is appended internally. E.g. use
+    #   "http://my.prestashop.com/", not "http://my.prestashop.com/api". URIs without scheme (e.g. "my.prestashop.com")
+    #   are assumed to be http:// by default.
+    # @return [String] the URI of the API for this Prestashop instance
+    def self.api_uri(base_url)
+      # Base URL must end in '/' so that we can properly append other path fragments for the API paths
+      base_url.strip!
+      base_url += '/' unless base_url[-1] == '/'
+
+      # Add http:// scheme if the scheme is missing from the base url
+      base_url = 'http://' + base_url if URI.parse(base_url).scheme.nil?
+
+      uri = URI.join base_url, API_PATH
+      return uri.to_s
+    end
+  end
+end

data/lib/prestashopper/version.rb

@@ -0,0 +1,3 @@
+module Prestashopper
+  VERSION = '0.1.0'
+end

data/prestashopper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prestashopper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prestashopper'
+  spec.version       = Prestashopper::VERSION
+  spec.authors       = ['Alfredo Amatriain']
+  spec.email         = ['geralt@gmail.com']
+
+  spec.summary       = %q{Ruby gem to interact with the Prestashop API.}
+  spec.homepage      = 'https://github.com/amatriain/prestashopper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: prestashopper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alfredo Amatriain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- geralt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prestashopper.rb
+- lib/prestashopper/api.rb
+- lib/prestashopper/uri_handler.rb
+- lib/prestashopper/version.rb
+- prestashopper.gemspec
+homepage: https://github.com/amatriain/prestashopper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby gem to interact with the Prestashop API.
+test_files: []