lce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42308cd92f775b295eda5cee11a402c71fa922bd
+  data.tar.gz: 43f4d00d85f70453cb424a175b30e112f8179483
+SHA512:
+  metadata.gz: c590bcd48a506cbc23f7b59a74b44c72ff746fd5876a0baceebb6e75e402938699503ba47e1c68ea5bf4ece3f4385e67391fbcd58b0ac0a5cfae82dd8bff3d1c
+  data.tar.gz: fa8bdae09510c95a474c9b4d9552cbbd1c9d0dc68d1f3bba0dd00e8ced48d73d1d2c18b42a0e7887743995f5d076dc2439fd95cca27716421d7b7b954338c61b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+ruby-lce

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-lce.gemspec
+gemspec
+
+gem 'awesome_print'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Low Cost Express SAS
+
+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,98 @@
+# Lce
+
+A Ruby library that provides an interface to the LCE web services.
+
+## Installation
+
+This library is packaged as a gem. So you can add this line to your application's Gemfile:
+
+    gem 'lce'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lce
+    
+## Configuration
+
+You can configure this gem by using a configuration block :
+
+    Lce.configure do |config|
+      config.environment = :staging
+      config.login = 'login'
+      config.password = 'password'
+    end
+
+If you are using the gem in a Rails application, you can store this configuation with oher initializers in : 
+
+    RAILS_ROOT/config/initializers/lce.rb
+    
+Here are all available configuration options with their default values : 
+
+    Lce.configure do |config|
+      # Switch to :production when you are ready to go live
+      config.environment = :staging 
+
+      # No default for authentication attributes. You should have received that by email if not ask us at support@lce.io
+      config.login = 
+      config.password =
+
+      # You can set it to Rails.logger if you are using a rails app.
+      config.logger = Logger.new(STDOUT)
+
+      # You can set your own application's name and version.
+      config.application = 'ruby-lce' 
+      config.version = '0.0.1'
+    end
+
+## Usage
+
+Once configured, you can start making request to the lce webservices. The full documentation for all requests and attributes is available at https://www.lce.io/docs
+
+### Requesting a quote
+
+    quote_params = {
+      shipper: {city: "Toulouse", postal_code: "31000", country:"FR"},
+      recipient: {city: "Nice", postal_code: "06000", country: "FR", is_a_company: false},
+      parcels: [
+        {length: 25,height: 25, width: 25, weight: 3}
+      ]
+    }
+    quote = Lce::Quote.request(quote_params)
+
+### Placing an order
+
+    order_params = {
+      shipper: {name: "Firstname Lastname", street: "999, street name", phone: "+33699999999", email: "support@lce.io"},
+      recipient: {name: "Firstname Lastname", street: "111, other street", phone: "+33600000", email: "support@lce.io"},
+      parcels: [{description: 'Gift'}]
+    }
+    
+    # First, we select an offer we want to order (for this example, we are using the first one)
+    offer = quote.offers.first
+    order = offer.place_order(order_params)
+
+### Retrieving the labels
+
+    # We can retrieve the labels
+    labels = order.labels
+    # and write them to our drive
+    File.open("order-#{order.id}.pdf", "wb") do |f|
+      f.write(labels)
+    end  
+
+### Getting the tracking informations
+    
+    # And then, we can get the tracking events by parcels
+    order.tracking
+
+## Contributing
+
+1. Fork it ( http://github.com/lce/ruby-lce/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task :default => [:spec]

data/lce.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lce"
+  spec.version       = Lce::VERSION
+  spec.authors       = ["Florent Piteau", "Thomas Belliard"]
+  spec.email         = ["info@lce.io"]
+  spec.summary       = %q{A Ruby library that provides an interface to the LCE web services.}
+  spec.homepage      = "http://lce.io/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.18.0'
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.9.1"
+  spec.add_dependency "faraday_middleware-parse_oj", "~> 0.3.0"  
+  spec.add_dependency "hashie", "~> 3.2.0"  
+
+end

data/lib/lce.rb

@@ -0,0 +1,72 @@
+require "lce/version"
+require "lce/client"
+require "lce/offer"
+require "lce/quote"
+require "lce/order"
+require "logger"
+require "awesome_print"
+
+module Lce
+  class << self
+    attr_accessor :configuration, :client
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.check
+    begin  
+      client.get
+    rescue Lce::Client::Errors::LceError => e
+      if configuration.raise_lce_errors
+        raise e      
+      else
+        configuration.logger.warn(e.to_s)
+      end
+      return false
+    end
+  end
+
+
+  class Configuration
+    attr_accessor :login, :password, :environment, :api_version, :http_adapter, :raise_lce_errors, :logger, :application, :version
+
+    def initialize
+      @environment = :staging
+      @api_version = 1
+      @http_adapter = Faraday.default_adapter
+      @raise_lce_errors = true
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::DEBUG   
+      @application = 'ruby-lce'    
+      @version = Lce::VERSION
+    end
+    
+    def environment=(value)
+      raise 'Environment must be :staging or :production' unless [:staging, :production].include?(value)
+      @environment = value
+    end
+    
+    def application=(app)
+      @application = "#{app} (ruby-lce)"
+    end
+
+    def version=(version)
+      @version = "#{version} (#{Lce::VERSION})"
+    end
+  end
+end
+

data/lib/lce/client.rb

@@ -0,0 +1,34 @@
+require 'lce/client/connection'
+require 'lce/client/errors'
+require 'lce/client/request'
+
+module Lce
+  class Client
+  
+    HOSTS = {
+      development: "http://localhost:9000",
+      staging: "https://test.lce.io",
+      production: "https://api.lce.io"
+    }
+    
+    include Connection
+    include Request  
+    include Errors
+      
+    attr_accessor :http_adapter
+    
+    def initialize
+      @http_adapter = Lce.configuration.http_adapter
+    end
+    
+    def host
+      HOSTS[Lce.configuration.environment]
+    end
+    
+    def api_version
+      raise VersionError.new("Wrong API version",' wrong_api_version', "Version must be 1.") if Lce.configuration.api_version != 1
+      'v'+Lce.configuration.api_version.to_s
+    end
+
+  end
+end

data/lib/lce/client/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/parse_oj'
+
+module Lce
+  class Client
+    module Connection
+      private
+        def connection
+          Faraday.new(:url => host) do |faraday|
+            faraday.basic_auth(Lce.configuration.login, Lce.configuration.password)
+            faraday.headers['Lce-Origin-Application'] = Lce.configuration.application
+            faraday.headers['Lce-Origin-Version'] = Lce.configuration.version
+            faraday.request :json
+            faraday.response :mashify               
+            faraday.response :oj, :content_type => /\bjson$/                           
+            faraday.response :logger, Lce.configuration.logger
+            faraday.adapter  http_adapter
+          end        
+        end
+    end
+  end
+end

data/lib/lce/client/errors.rb

@@ -0,0 +1,25 @@
+module Lce
+  class Client
+    module Errors
+      class LceError < StandardError
+        attr_reader :type, :details
+        def initialize(msg, type, details)
+          super(msg)
+          @type = type
+          @details = details
+        end
+        def to_s
+          s = super
+          d = (@details.is_a? Array)? @details.join(' ') : @details
+          s+= "\n#{d}" if d && !d.empty?
+          s
+        end
+      end
+      class VersionError <  LceError; end
+      class ConnectionError <  LceError; end      
+      class AccessDenied <  LceError; end
+      class AccountDisabled <  LceError; end
+      
+    end
+  end
+end

data/lib/lce/client/request.rb

@@ -0,0 +1,80 @@
+module Lce
+  class Client
+    module Request
+      def get(resource = nil, id = nil, action = nil, format = nil, params = nil)
+        p = path(resource, id, action, format)
+        request(:get, p, params, format)
+      end
+
+      def post(resource = nil, params = nil)
+        p = path(resource)
+        request(:post, p, params)
+      end
+
+
+      private
+
+      def path(resource = nil, id = nil, action = nil, format = nil)
+        path = []
+        path << api_version << resource.to_s if resource
+        path << id.to_s if id
+        path << action.to_s if action
+        path = '/'+path.join('/')
+        path += ".#{format}" if format
+        return path
+      end
+
+      def request(action, path, params, format = nil)
+        response = connection.send(action, path, params)
+        if success?(response)
+          return process_data(response.headers['content-type'], response.body)
+        else
+          error!(response)
+          return nil
+        end
+      end
+
+      def process_data(type, body)
+        case type
+          when 'application/json'
+            process_json(body)
+          when 'application/pdf'
+            process_pdf(body)
+        end
+      end
+
+      def process_pdf(body)
+        body
+      end
+      
+      def process_json(body)
+        if body.data.is_a? Array
+          a = PaginatedArray.new(body[:count], body[:page], body[:per_page])
+          body.data.each do |d|
+            a << d
+          end
+          return a
+        else
+          return body.data
+        end
+      end
+      
+      def success?(response)
+        response.status.between?(200, 299) && (response.headers['content-type'] != 'application/json' || response.body.status == "success")
+      end
+      
+      def error!(response)
+        if response.body.error
+          case response.body.error.type
+            when 'access_denied'
+              raise Lce::Client::AccessDenied.new(response.body.error.message, response.body.error.type, response.body.error.details)
+            when 'account_disabled'
+              raise Lce::Client::AccountDisabled.new(response.body.error.message, response.body.error.type, response.body.error.details)
+            when 'internal', 'resource_not_found'
+              raise Lce::Client::LceError.new(response.body.error.message, response.body.error.type, response.body.error.details)              
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lce/offer.rb

@@ -0,0 +1,25 @@
+require 'hashie'
+module Lce
+  class Offer < Hashie::Mash
+    class << self
+      def find(id)
+        response = Lce.client.get('offers', id)
+        new(response)
+      end
+      
+    end
+    
+    def place_order(params)
+      params.merge!(offer_id: id)
+      Order.place(params)    
+    end
+
+    def available_delivery_locations(params)
+      return [] unless product.preset_delivery_location == true
+      Lce.client.get('offers', id, 'available_delivery_locations', nil , {location: params }).map! do |l|
+        Hashie::Mash.new(l)
+      end
+    end
+    
+  end
+end