queenbee 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e2ecbf88bab97a30dc9d76d899d83235e11bffe
+  data.tar.gz: 1f4d8257dcbe653e9a02dd74f280a817a6ca5df2
+SHA512:
+  metadata.gz: 8fcc250632939434fc3decdb721606b0d9fbcbcd05481d74888ff40f160f8abf226fe54033b10cea373df6b803d8d9670a00fb2ac35cccb0de27a652443e4757
+  data.tar.gz: 89eab4a4c89771376015ebd335a382e0f256365dd183955a957fe8c6f31aa2376175e8139ffac678dc641ba7c64eb8af10e46cbe72c774b7c26eaa3317f8cef7

data/README.md

@@ -0,0 +1,76 @@
+# Queenbee
+
+[![Build Status](https://semaphoreapp.com/api/v1/projects/7959e7f9-8fcb-4d10-85fe-79bc840b028c/262003/shields_badge.svg)](https://semaphoreapp.com/olimart/queenbee-ruby)
+
+Simple gem for communicating with external API. Heavily inspired by stripe gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'queenbee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queenbee
+
+## Usage
+
+In your app
+
+1. Set token
+
+```ruby
+Queenbee.token = ENV['QUEENBEE_TOKEN']
+```
+
+2. Send order
+
+```ruby
+Queenbee::Order.create(
+  date: Time.now,
+  currency: 'cad',
+  client_email: 'client@email.com',
+  amount: '15',
+  total_price: '15',
+  city: 'Nancy',
+  country: 'France',
+  shipping: 0,
+  uid: SecureRandom.hex(4),
+  source: 'Stripe payment form'
+)
+```
+
+**For Sinatra app** you may need to add `require 'bundler/setup'`
+
+
+## Tests
+
+```ruby
+rake test
+```
+
+## Complete list of parameters
+
+- uid (string, must be unique per application)
+- date (datetime. default to record creation timestamp. Should be used to send historic data)
+- currency (string. i.e. 'CAD')
+- amount (decimal)
+- tax (decimal)
+- shipping (decimal)
+- total_price (decimal)
+- gift (boolean, default false)
+- coupon (boolean, default false)
+- coupon_code (string)
+- country (string. i.e. 'Canada')
+- city (string)
+- url (string)
+- client_email (string)
+- products_count (integer, default 1)
+- subscribed_at (datetime. For recurring order)
+- unsubscribed_at (datetime. For recurring order)
+- fees (decimal)

data/lib/queenbee/api_operations/create.rb

@@ -0,0 +1,16 @@
+module Queenbee
+  module APIOperations
+    module Create
+      module ClassMethods
+        def create(params={}, token=nil)
+          response, token = Queenbee.request(:post, self.url, token, params)
+          response
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/queenbee/api_operations/update.rb

@@ -0,0 +1,17 @@
+module Queenbee
+  module APIOperations
+    module Update
+      module ClassMethods
+        def save(params = {}, token = nil)
+          url = self.url + '/' + params[:uid]
+          response, token = Queenbee.request(:put, url, token, params)
+          response
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/queenbee/api_resource.rb

@@ -0,0 +1,21 @@
+module Queenbee
+  class APIResource < QueenbeeObject
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+
+    def self.url()
+      if self == APIResource
+        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses)')
+      end
+      "/#{CGI.escape(class_name.downcase)}s"
+    end
+
+    def url
+      unless id = self['id']
+        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
+      end
+      "#{self.class.url}/#{CGI.escape(id)}"
+    end
+  end
+end

data/lib/queenbee/errors/api_connection_error.rb

@@ -0,0 +1,4 @@
+module Queenbee
+  class APIConnectionError < QueenbeeError
+  end
+end

data/lib/queenbee/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Queenbee
+  class APIError < QueenbeeError
+  end
+end

data/lib/queenbee/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Queenbee
+  class AuthenticationError < QueenbeeError
+  end
+end

data/lib/queenbee/errors/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module Queenbee
+  class InvalidRequestError < QueenbeeError
+    attr_accessor :param
+
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+end

data/lib/queenbee/errors/queenbee_error.rb

@@ -0,0 +1,20 @@
+module Queenbee
+  class QueenbeeError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/queenbee/order.rb

@@ -0,0 +1,6 @@
+module Queenbee
+  class Order < APIResource
+    include Queenbee::APIOperations::Create
+    include Queenbee::APIOperations::Update
+  end
+end

data/lib/queenbee/queenbee_object.rb

@@ -0,0 +1,5 @@
+module Queenbee
+  class QueenbeeObject
+
+  end
+end

data/lib/queenbee/version.rb

@@ -0,0 +1,3 @@
+module Queenbee
+  VERSION = "0.0.2"
+end

data/lib/queenbee.rb

@@ -0,0 +1,143 @@
+# Queenbee Ruby bindings
+require "cgi"
+require "set"
+require "openssl"
+require "json"
+require "net/http"
+require "uri"
+
+# Version
+require "queenbee/version"
+
+# API operations
+require "queenbee/api_operations/create"
+require "queenbee/api_operations/update"
+
+# Resources
+require "queenbee/queenbee_object"
+require "queenbee/api_resource"
+require "queenbee/order"
+
+# Errors
+require "queenbee/errors/queenbee_error"
+require "queenbee/errors/api_error"
+require "queenbee/errors/api_connection_error"
+require "queenbee/errors/invalid_request_error"
+require "queenbee/errors/authentication_error"
+
+module Queenbee
+  @api_base = "https://queenbee-yafoy.herokuapp.com/api"
+
+  class << self
+    attr_accessor :token, :api_base, :verify_ssl_certs, :api_version
+  end
+
+  def self.api_url(url="")
+    @api_base + url
+  end
+
+  def self.request(method, url, token, params={}, headers={})
+    unless token ||= @token
+      raise AuthenticationError.new("No token provided")
+    end
+
+    url = api_url(url)
+
+    begin
+      uri = URI(url)
+      request = Net::HTTP::Post.new(uri) if method == :post
+      request = Net::HTTP::Put.new(uri) if method == :put
+      request["User-Agent"] = "Queenbee gem"
+      request["Authorization"] = "Token token=\"#{token}\""
+      request["Content-Type"] = "application/json"
+      request.body = params.to_json
+
+      http = Net::HTTP.new(uri.hostname, uri.port)
+
+      # see http://www.rubyinside.com/how-to-cure-nethttps-risky-default-https-behavior-4010.html
+      # for info about ssl verification
+
+      http.use_ssl = true if uri.scheme == "https"
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if uri.scheme == "https"
+
+      response = http.start {|h|
+        h.request(request)
+      }
+
+      # since http.request doesn't throw such exceptions, check them by status codes
+      handle_api_error(response.code, response.body)
+
+    rescue SocketError => e
+      handle_connection_error(e)
+    rescue NoMethodError => e
+      handle_connection_error(e)
+    rescue OpenSSL::SSL::SSLError => e
+      handle_connection_error(e)
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
+      handle_connection_error(e)
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError  => e
+      handle_connection_error(e)
+    end
+
+    [response, token]
+  end
+
+  def self.retrieve(id, opts={})
+    instance = self.new(id, opts)
+    instance
+  end
+
+  def self.handle_connection_error(e)
+    case e
+      when SocketError
+        message = "Unexpected error when trying to connect to Queenbee."
+
+      when NoMethodError
+        message = "Unexpected HTTP response code"
+
+      else
+        message = "Unexpected error communicating with Queenbee."
+    end
+
+    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = JSON.parse(rbody)
+    rescue JSON::ParserError
+      raise general_api_error(rcode, rbody)
+    end
+
+    case rcode
+      when 400, 404, 422
+        raise invalid_request_error error, rcode, rbody, error_obj
+      when 401
+        raise authentication_error error, rcode, rbody, error_obj
+      when 500
+        raise api_error error, rcode, rbody, error_obj
+      else
+        # raise api_error error, rcode, rbody, error_obj
+    end
+
+  end
+
+  def self.invalid_request_error(error, rcode, rbody, error_obj)
+    InvalidRequestError.new(error[:message], error[:param], rcode,
+                            rbody, error_obj)
+  end
+
+  def self.authentication_error(error, rcode, rbody, error_obj)
+    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.api_error(error, rcode, rbody, error_obj)
+    APIError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.general_api_error(rcode, rbody)
+    APIError.new("Invalid response object from API: #{rbody.inspect} " +
+                 "(HTTP response code was #{rcode})", rcode, rbody)
+  end
+end

data/test/queenbee/order_test.rb

@@ -0,0 +1,56 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+module Queenbee
+  class OrderTest < Test::Unit::TestCase
+    should "create should return status 201" do
+      response = Queenbee::Order.create(
+                  date: "2014-07-01 14:50:28",
+                  currency: "CAD", city: "Paris",
+                  country: "Canada", client_email: "d@email.com",
+                  uid: SecureRandom.hex(4))
+      assert_equal "201", response.code
+    end
+
+    should "raise Queenbee::AuthenticationError if not token provided" do
+      Queenbee.token = nil
+      assert_raises(Queenbee::AuthenticationError) {Queenbee::Order.create}
+    end
+
+    should "raise Queenbee::InvalidRequestError if not enough parameters" do
+      begin
+      rescue JSON::ParserError
+        assert_raises(Queenbee::InvalidRequestError) { Queenbee::Order.create }
+      end
+    end
+
+    should "Update should return 200" do
+      uid = SecureRandom.hex(4)
+      response1 = Queenbee::Order.create(
+          date: "2014-07-01 14:50:28",
+          currency: "CAD", city: "Paris",
+          country: "Canada", client_email: "d@email.com",
+          uid: uid)
+      response = Queenbee::Order.save(
+          date: "2014-07-01 14:50:28",
+          currency: "CAD", city: "Paris",
+          country: "Canada", client_email: "kk@email.com",
+          uid: uid)
+      assert_equal "200", response.code
+    end
+
+    should "Update should return 404 if UID missing" do
+      response1 = Queenbee::Order.create(
+          date: "2014-07-01 14:50:28",
+          currency: "CAD", city: "Paris",
+          country: "Canada", client_email: "d@email.com",
+          uid: SecureRandom.hex(4))
+      response = Queenbee::Order.save(
+          date: "2014-07-01 14:50:28",
+          currency: "CAD", city: "Paris",
+          country: "Canada", client_email: "kk@email.com",
+          uid: "")
+      assert_equal "404", response.code
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'queenbee'
+require 'test/unit'
+require 'shoulda'
+
+class Test::Unit::TestCase
+  setup do
+  	Queenbee.api_base = 'http://localhost:3024/api'
+    Queenbee.token    = '111'
+  end
+
+  teardown do
+    Queenbee.token = nil
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: queenbee
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Olivier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: E-commerce analytics platform
+email:
+- olivier@yafoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/queenbee.rb
+- lib/queenbee/api_operations/create.rb
+- lib/queenbee/api_operations/update.rb
+- lib/queenbee/api_resource.rb
+- lib/queenbee/errors/api_connection_error.rb
+- lib/queenbee/errors/api_error.rb
+- lib/queenbee/errors/authentication_error.rb
+- lib/queenbee/errors/invalid_request_error.rb
+- lib/queenbee/errors/queenbee_error.rb
+- lib/queenbee/order.rb
+- lib/queenbee/queenbee_object.rb
+- lib/queenbee/version.rb
+- test/queenbee/order_test.rb
+- test/test_helper.rb
+homepage: https://github.com/olimart/queenbee-ruby
+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.8
+signing_key: 
+specification_version: 4
+summary: Gem to send e-commerce orders to the Queenbee central app.
+test_files:
+- test/queenbee/order_test.rb
+- test/test_helper.rb