prestashopper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb45387162f612a1a13f6fddc9aa76fe44439c7d
-  data.tar.gz: f9cbe7668eeae82ca4aab0d8a8b53f86f99693ab
+  metadata.gz: a7defedaa887ce629c6fbd24c8d898ed9a53bff7
+  data.tar.gz: bc8db2121a7c38e8fe0099c474cab3810c4463c9
 SHA512:
-  metadata.gz: fe784e19c467bbb8d600fe7a53634584a45bfa538207d485468f20d35d89116f099f3b438d62828343458215fb35d7e6b944257714f7d308a8a3587054c4190a
-  data.tar.gz: 6902fa4d21968891c88db3450b4868741a2d690d8f4d75a795936529020931285a711721908f99f170de1f4fbdb7cbed016ffca1668d0607157ab0b418163101
+  metadata.gz: 191b15c18a9d4d1cf3da933f5ecd9a0d6442487a70dfb7cb064717267c59a671235c7dd5d4674c24fda1449cf3e2c52dd2e2fa16704be6dd8c10cb72897c7078
+  data.tar.gz: 8850f7fb3acef3b9ee0d7b936c7833b1d878f89b35eb067ea25062043e4d25d049d23aed4c8f1a133645f399fea77620180fa2a1e3253906705a5b4cb318bad7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 (August 19, 2016)
+
+Features: 
+
+- Added badges to README (gem version, build status, rubydoc.info docs)
+- Get list of resources an API key can access
+- Get all products as an array of hashes
+
 ## 0.1.0 (August 12, 2016)
 
 Features: 

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/prestashopper.svg)](https://badge.fury.io/rb/prestashopper)
+[![Build Status](https://semaphoreci.com/api/v1/amatriain/prestashopper/branches/master/badge.svg)](https://semaphoreci.com/amatriain/prestashopper)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/amatriain/prestashopper/master)
+
 # Prestashopper
 
 Prestashopper is a ruby gem to interact with a Prestashop API. It has been tested with Prestashop v1.6.1.2
@@ -42,6 +46,26 @@ Prestashopper.valid_key? 'my.prestashop.com', 'VALID_KEY'
 => true
 ```
 
+### Getting an API instance
+```
+api = Prestashopper::API.new 'my.prestashop.com', 'VALID_KEY'
+```
+
+### Listing resources that can be accessed from an API instance
+```
+api.resources
+ => [:customers, :orders, :products] 
+```
+
+### Gettting products
+```
+products = api.get_products
+products[0].description
+=>  "product 1"
+products[0].price
+=> "24.71"
+```
+
 ## 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`.

data/lib/prestashopper.rb

@@ -1,6 +1,8 @@
 require 'prestashopper/version'
 require 'rest-client'
+require 'nokogiri'
 require 'prestashopper/api'
+require 'prestashopper/product'
 require 'prestashopper/uri_handler'
 
 # @author Alfredo Amatriain <geralt@gmail.com>

data/lib/prestashopper/api.rb

@@ -3,5 +3,52 @@ module Prestashopper
   # Each instance represents a Prestashop API instance.
   class API
 
+    # @return [String] URI of the Prestashop API
+    attr_reader :api_uri
+
+    # @return [String] API key
+    attr_reader :key
+
+    # Create a new 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"
+    # @param key [String] a valid API key
+    def initialize(url, key)
+      @api_uri = UriHandler.api_uri url
+      @key = key
+      @resources_res = RestClient::Resource.new @api_uri, user: @key, password: ''
+    end
+
+    # List resources that the API key can access
+    # @return [Array<Symbol>] list of resources the API can access
+    def resources
+      xml = @resources_res.get.body
+      xml_doc = Nokogiri::XML xml
+      nodes = xml_doc.xpath '/prestashop/api/*'
+      resources_list = []
+      nodes.each{|n| resources_list << n.name.to_sym}
+      return resources_list
+    end
+
+    # Get all products data
+    # @return [Array<Hash>] list of products. Each product is represented by a hash with all its attributes.
+    def get_products
+      # /api/products returns XML with the IDs of each individual product
+      xml_products = @resources_res['products'].get.body
+      xml_products_doc = Nokogiri::XML xml_products
+      products_nodes = xml_products_doc.xpath '/prestashop/products/*/@id'
+      ids_list = []
+      products_nodes.each{|n| ids_list << n.value}
+
+      # GET each individual product to get the whole data
+      products = []
+      ids_list.each do |id|
+        xml_product = @resources_res["products/#{id}"].get.body
+        product = Product.xml2hash xml_product
+        products << product
+      end
+
+      return products
+    end
   end
 end

data/lib/prestashopper/product.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/hash'
+
+module Prestashopper
+
+  # Has methods to convert the XML returned from the API to a ruby hash
+  class Product
+
+    # Convert a product XML returned by the Prestashop API to a ruby hash, more manageable
+    # @param xml [String] XML returned by the Prestashop API
+    # @return [Hash] the product converted to a hash representation
+    def self.xml2hash(xml)
+      xml_doc = Nokogiri::XML( xml).remove_namespaces!
+      # Strip surrounding tag
+      nodes = xml_doc.xpath '/prestashop/*'
+      product_xml = nodes.to_s
+      product_hash = Hash.from_xml product_xml
+
+      return product_hash['product']
+    end
+  end
+end

data/lib/prestashopper/version.rb

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

data/prestashopper.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prestashopper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alfredo Amatriain
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +139,7 @@ files:
 - bin/setup
 - lib/prestashopper.rb
 - lib/prestashopper/api.rb
+- lib/prestashopper/product.rb
 - lib/prestashopper/uri_handler.rb
 - lib/prestashopper/version.rb
 - prestashopper.gemspec