promoqui-api-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a65b12aea27b17e9b2e5d6d73d5ffa05b3997201
+  data.tar.gz: 1b8295cd31a68857a5f6ff9eded09a2b3df8fc27
+SHA512:
+  metadata.gz: 912165fb1e50e7c0573b4d05ef997d4baac0f99e04acc5d8c2d2139f47f2fffc395957124fcdaf68b7d79dacc8b132f1eb400ebd7856793717fc98eace54b193
+  data.tar.gz: c37b57cde25cda4a1e6dc6ea3dfce046a7a1b16b3c68d44e5eee922e83bce9cbad3a170c48037dab1dd45b62334455bfd13b42ac730ee72a3b22a73755f58eab

data/lib/pqsdk.rb

@@ -0,0 +1,10 @@
+require 'net/http'
+require 'json'
+require 'time'
+require 'pqsdk/city'
+require 'pqsdk/leaflet'
+require 'pqsdk/rest_layer'
+require 'pqsdk/settings'
+require 'pqsdk/store'
+require 'pqsdk/token'
+require 'pqsdk/version'

data/lib/pqsdk/city.rb

@@ -0,0 +1,46 @@
+module PQSDK
+  class City
+    attr_accessor :id, :name, :inhabitants, :latitude, :longitude
+
+    def self.find(name)
+      res = RestLayer.get('v1/cities', { q: name }, { 'Authorization' => "Bearer #{Token.access_token}" })
+      if res[0] == 200
+        City.from_json res[1]
+      elsif res[0] == 404
+        nil
+      else
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      end
+    end
+
+    def self.find_or_create(name)
+      city = self.find(name)
+      return city if city
+
+      city = City.new
+      city.name = name
+      city.save
+
+      city
+    end
+
+    def save
+      res = RestLayer.post('v1/cities', { name: name }, { 'Authorization' => "Bearer #{Token.access_token}" })
+
+      if res[0] != 201
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      end
+    end
+
+  private
+    def self.from_json(json)
+      result = City.new
+
+      json.each do |key, val|
+        result.send("#{key}=", val)
+      end
+
+      result
+    end
+  end
+end

data/lib/pqsdk/leaflet.rb

@@ -0,0 +1,55 @@
+module PQSDK
+  class Leaflet
+    attr_accessor :id, :name, :url, :start_date, :end_date, :pdf_data, :store_ids
+
+    def initialize
+      self.store_ids = []
+    end
+
+    def self.find(url)
+      res = RestLayer.get('v1/leaflets', { url: url }, { 'Authorization' => "Bearer #{Token.access_token}" })
+      if res[0] == 200
+        Leaflet.from_json res[1]
+      elsif res[0] == 404
+        nil
+      else
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      end
+    end
+
+    def save
+      method = :post
+      endpoint = "v1/leaflets"
+      expected_status = 201
+
+      fields = {}
+      fields['name'] = name unless name.nil?
+      fields['url'] = url unless url.nil?
+      fields['start_date'] = start_date unless start_date.nil?
+      fields['end_date'] = end_date unless end_date.nil?
+      fields['pdf_data'] = pdf_data unless pdf_data.nil?
+      fields['store_ids'] = store_ids unless store_ids.nil?
+
+      res = RestLayer.send(method, endpoint, fields, { 'Authorization' => "Bearer #{Token.access_token}" })
+
+      if res[0] != expected_status
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      else
+        if method == :post
+          self.id = res[1]['id']
+        end
+      end
+    end
+
+  private
+    def self.from_json(json)
+      result = Leaflet.new
+
+      json.each do |key, val|
+        result.send("#{key}=", val)
+      end
+
+      result
+    end
+  end
+end

data/lib/pqsdk/rest_layer.rb

@@ -0,0 +1,66 @@
+module PQSDK
+  class RestLayer
+    def self.get(endpoint, parameters, headers)
+      url = URI.parse("http://#{Settings.host}/#{endpoint}")
+      url.query = URI.encode_www_form(parameters)
+      req = Net::HTTP::Get.new(url.request_uri)
+
+      headers.each do |name, value|
+        req[name.to_s] = value
+      end
+
+      res = Net::HTTP.start(url.host, url.port) do |http|
+        http.request(req)
+      end
+
+      check_status(res.code.to_i, res.body)
+
+      [ res.code.to_i, JSON.parse(res.body), res.to_hash ]
+    end
+
+    def self.post(endpoint, parameters, headers)
+      url = URI.parse("http://#{Settings.host}/#{endpoint}")
+      req = Net::HTTP::Post.new(url.request_uri)
+      req.set_form_data(parameters)
+
+      headers.each do |name, value|
+        req[name.to_s] = value
+      end
+
+      res = Net::HTTP.start(url.host, url.port) do |http|
+        http.request(req)
+      end
+
+      check_status(res.code.to_i, res.body)
+      [ res.code.to_i, JSON.parse(res.body), res.to_hash ]
+    end
+
+    def self.put(endpoint, parameters, headers)
+      url = URI.parse("http://#{Settings.host}/#{endpoint}")
+      req = Net::HTTP::Put.new(url.request_uri)
+      req.set_form_data(parameters)
+
+      headers.each do |name, value|
+        req[name.to_s] = value
+      end
+
+      res = Net::HTTP.start(url.host, url.port) do |http|
+        http.request(req)
+      end
+
+      check_status(res.code.to_i, res.body)
+      [ res.code.to_i, JSON.parse(res.body), res.to_hash ]
+    end
+
+  private
+    def self.check_status(code, body)
+      if code >= 500
+        raise Exception.new("Internal Server Error")
+      elsif code == 400
+        raise Exception.new("Bad Request. This usually imples a bug in this gem! Error: #{JSON.parse(body)['error']}")
+      elsif code == 401
+        raise Exception.new("You are not authorized to perform that request")
+      end
+    end
+  end
+end

data/lib/pqsdk/settings.rb

@@ -0,0 +1,22 @@
+module PQSDK
+  class Settings
+    @@host = nil
+    @@app_secret = nil
+
+    def self.host
+      @@host
+    end
+
+    def self.host=(val)
+      @@host = val
+    end
+
+    def self.app_secret
+      @@app_secret
+    end
+
+    def self.app_secret=(val)
+      @@app_secret = val
+    end
+  end
+end

data/lib/pqsdk/store.rb

@@ -0,0 +1,74 @@
+module PQSDK
+  class Store
+    attr_accessor :id, :name, :address, :zipcode, :latitude, :longitude, :phone, :city_id, :origin, :opening_hours
+
+    def self.find(address, zipcode, retailer = nil)
+      res = RestLayer.get('v1/stores', { address: address, zipcode: zipcode, retailer: retailer }, { 'Authorization' => "Bearer #{Token.access_token}" })
+      if res[0] == 200
+        Store.from_json res[1]
+      elsif res[0] == 404
+        nil
+      else
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      end
+    end
+
+    def self.get(id)
+      res = RestLayer.get("v1/stores/#{id}", { }, { 'Authorization' => "Bearer #{Token.access_token}" })
+      if res[0] == 200
+        Store.from_json res[1]
+      elsif res[0] == 404
+        nil
+      else
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      end
+    end
+
+    def save
+      if self.id != nil
+        method = :put
+        url = "v1/stores/#{self.id}"
+        expected_status = 200
+      else
+        method = :post
+        url = "v1/stores"
+        expected_status = 201
+      end
+
+      fields = {}
+      fields['name'] = name unless name.nil?
+      fields['address'] = address unless address.nil?
+      fields['zipcode'] = zipcode unless zipcode.nil?
+      fields['latitude'] = latitude unless latitude.nil?
+      fields['longitude'] = longitude unless longitude.nil?
+      fields['city_id'] = city_id unless city_id.nil?
+      fields['origin'] = origin unless origin.nil?
+      fields['opening_hours'] = opening_hours.to_json unless opening_hours.nil?
+
+      res = RestLayer.send(method, url, fields, { 'Authorization' => "Bearer #{Token.access_token}" })
+
+      if res[0] != expected_status
+        raise Exception.new("Unexpected HTTP status code #{res[0]}")
+      else
+        if method == :post
+          self.id = res[1]['id']
+        end
+      end
+    end
+
+  private
+    def self.from_json(json)
+      result = Store.new
+
+      json.each do |key, val|
+        if key != 'country' && key != 'city'
+          result.send("#{key}=", val)
+        end
+      end
+
+      result.city_id = PQSDK::City.find(json['city']).id
+
+      result
+    end
+  end
+end

data/lib/pqsdk/token.rb

@@ -0,0 +1,25 @@
+module PQSDK
+  class Token
+    @@access_token = nil
+    @@expiration = nil
+
+    def self.get
+      res = RestLayer.get('v1/token', {}, { 'Authentication' => "Key #{Settings.app_secret}" })
+      
+      if res[0] == 200
+        @@access_token = res[1]['token']
+        @@expiration = Time.parse(res[1]['expired_at'])
+      end
+
+      @@access_token
+    end
+
+    def self.access_token
+      if @@access_token == nil || @@expiration <= Time.now
+        self.get
+      else
+        @@access_token
+      end
+    end
+  end
+end

data/lib/pqsdk/version.rb

@@ -0,0 +1,3 @@
+module PQSDK
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: promoqui-api-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francesco Boffa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem helps Crawler Writers to interact with the PromoQui REST API
+email: f.boffa@promoqui.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pqsdk.rb
+- lib/pqsdk/city.rb
+- lib/pqsdk/leaflet.rb
+- lib/pqsdk/rest_layer.rb
+- lib/pqsdk/settings.rb
+- lib/pqsdk/store.rb
+- lib/pqsdk/token.rb
+- lib/pqsdk/version.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A wrapper around PromoQui HTTP Crawler API
+test_files: []