licencetobill 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6837ba8d900d617642764c5cee1bd3d61df1500
+  data.tar.gz: b14f89bfbdda1fe429d0a4db97159bf06b51c332
+SHA512:
+  metadata.gz: 2d819bf718982a5efc27b32b5963c4920e3dc936c26f9c0e0a7a9de9160da8bd0114d6d8bd2ae48ed67b362aa0590dfa42271e5f5cb270ed73b95208522ae5c0
+  data.tar.gz: a649be735af8c2bb3575a763b1c9cbbf07384aa35aa76fa8e74e22ad9192d6b329992bd967d78d6b89492dfdfdff3c9b88aa5ba724eb20aa2aa2106a72c7ff76

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,151 @@
+# LicenceToBill
+
+A simple Ruby wrapper to easily interact with the [LicenceToBill API](https://api.licencetobill.com/?lcid=12).
+
+## Installation
+
+```ruby
+gem 'licencetobill'
+```
+or 
+
+```ruby
+gem install licencetobill
+```
+
+To install the latest dev version
+
+```ruby
+gem 'licencetobill', git: "git://github.com/gtroppee/licencetobill.git"
+```
+
+## Setup
+The only thing you need to provide is you LicenceToBill credentials. In the context of a Rails app, the best way to do so is to simply create a initializer for it:
+
+```ruby
+# config/initializers/licencetobill.rb
+LicenceToBill.configure do |config|
+  config.business_key = 'your_business_key'
+  config.agent_key    = 'your_agent_key'
+end
+```
+
+## Use cases
+To start using the gem, just proceed like so:
+
+* Provided your credentials are loaded
+```ruby
+@api = LicenceToBill::API.new
+```
+
+* Or if you want to load your credentials upon instantiation
+```ruby
+# config/initializers/licencetobill.rb
+@api = LicenceToBill::API.new('your_business_key', 'your_agent_key')
+```
+
+Then, simply use the object to interact with the platform:
+```ruby
+@offers = @api.get_offers
+```
+
+Here is a quick inventory of the methods at your disposal (per resource):
+
+#### USERS
+
+```ruby
+get_users
+#=> Get all the registered users
+
+get_user(key_user)
+#=> Get a single registered user
+
+get_users_for(key_feature)
+#=> Get the registered user that have access to a specific feature
+
+get_billing_address_for(key_user)
+#=> Get the registered address for a specific user
+
+register_user(key_user, name_user)
+#=> Register the user to LicenceToBill.
+# Note: . LicenceToBill gives you the liberty to give any key you want when you register the user. Just make sure this is and will remain unique for each user.
+```
+
+#### OFFERS
+
+```ruby
+get_offers(lcid = nil)
+#=> Get all the offers (language optional)
+
+get_offers_for(key_user)
+#=> Get all the offers for a specific user (with a redirection url if you choose to host the offers page directly in your app)
+
+get_stages
+#=> Get all the stages for a specific offer (of course you'll need to send this message to an offer object = @offer.get_stages)
+```
+
+#### FEATURES
+```ruby
+get_features(lcid = nil)
+#=> Get all the features
+
+get_features_for(key_user)
+#=> Get the features a specific user has access to
+
+get_features_details_for(key_feature, key_user)
+#=> Get details of a specific feature for a specific user
+```
+#### DEALS
+```ruby
+get_deals_for(key_user)
+#=> Get the deals of a specific user
+
+add_trial_for(key_user)
+#=> Create a trial offer for a specific user
+```
+
+#### STAGES
+```ruby
+get_features
+#=> Get the features of a specific stage (of course you'll need to send this message to a stage object = @stage.get_features)
+```
+**Note that if there is not resource returned, the gem will return an empty array []**
+
+Of course, you'll find all the information you need [here](https://api.licencetobill.com/?lcid=12).
+
+## Customisation
+This gem is only aiming at making it easier to read and write data from and to LicenceToBill, but if you want more flexibility/logic to it, you can easily add extra behaviour, like so:
+
+```ruby
+require 'licencetobill'
+
+LicenceToBill::Deal.class_eval do
+  
+  # Make the end date independent from the fact that the deal can be renewed or not
+  def end_date
+    if respond_to?(:date_renewal)
+      date_renewal
+    elsif respond_to?(:date_end)
+      date_end
+    end
+  end
+
+  def price
+    self.amount.to_i / 100
+  end
+
+end
+```
+All LicenceToBill resources have their own corresponding classes so you can basically add any behaviour you want for your app. Just FYI, the current resources are:
+
+* Users
+* Offers
+* Features
+* Stages
+* Deals
+* UserAddress (this one is not a resource per say, but being able to customise it as well might come in handy)
+
+
+## Contribution
+Contribution are more than welcome, be sure to add relevant unit tests and pass them all before submitting any code.
+

data/lib/licencetobill/api.rb

@@ -0,0 +1,89 @@
+module LicenceToBill
+  class << self
+    attr_accessor :configuration
+  end
+
+  class API
+    include LicenceToBill::Helpers
+    attr_accessor :token, :base_uri
+
+    def initialize(business_key = LicenceToBill.configuration.business_key, agent_key = LicenceToBill.configuration.agent_key)
+      @business_key = business_key
+      @agent_key    = agent_key
+      @token        = set_token
+
+      # DEFAULTS
+      @base_uri = 'https://api.licencetobill.com/v2'
+    end
+
+    # USERS
+    def get_users
+      get_collection(LicenceToBill::User, call_to("/users"))
+    end
+
+    def get_user(key_user)
+      get_collection(LicenceToBill::User, call_to("/users/#{key_user}"))
+    end
+
+    def get_users_for(key_feature)
+      get_collection(LicenceToBill::User, call_to("/users/features/#{key_feature}"))
+    end
+
+    def get_billing_address_for(key_user)
+      get_collection(LicenceToBill::UserAddress, call_to("/address/users/#{key_user}"))
+    end
+
+    def register_user(key_user, name_user)
+      call_to("/users/#{key_user}", :post, { key_user: "#{key_user}", name_user: "#{name_user}" })
+    end
+
+    # FEATURES
+    def get_features(lcid = nil)
+      get_collection(LicenceToBill::Feature, call_to("/features/#{lcid}"))
+    end
+
+    def get_features_for(key_user)
+      get_collection(LicenceToBill::Feature, call_to("/features/users/#{key_user}"))
+    end
+
+    def get_features_details_for(key_feature, key_user)
+      get_collection(LicenceToBill::Feature, call_to("/features/#{key_feature}/users/#{key_user}"))
+    end
+
+    # OFFERS
+    def get_offers(lcid = nil)
+      get_collection(LicenceToBill::Offer, call_to("/offers/#{lcid}"))
+    end
+
+    def get_offers_for(key_user)
+      get_collection(LicenceToBill::Offer, call_to("/offers/users/#{key_user}"))
+    end
+
+    # DEALS
+    def get_deals_for(key_user)
+      get_collection(LicenceToBill::Deal, call_to("/deals/users/#{key_user}"))
+    end
+
+    def add_trial_for(key_user)
+      call_to("/trial/#{key_user}", :post)
+    end
+
+    protected
+      def set_token
+        token = Base64.encode64("#{@business_key}:#{@agent_key}").delete!("\n")
+        "Basic #{token}"
+      end
+
+      def call_to(endpoint, method = :get, params = {})
+        HTTParty.send(method, 
+                      "#{@base_uri}#{endpoint}", 
+                      headers: { "Authorization" => @token, 'Content-Type' => "application/json" },
+                      body: params.to_json)
+      end
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/licencetobill/concerns.rb

@@ -0,0 +1,19 @@
+module LicenceToBill
+  module Concerns
+
+    include LicenceToBill::Helpers
+    
+    def initialize(data_source)
+      @data_source = data_source
+    end
+
+    def method_missing(method_name)
+      super unless @data_source.has_key?("#{method_name}")
+      @data_source["#{method_name}"]
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @data_source.has_key?("#{method_name}") || super
+    end
+  end
+end

data/lib/licencetobill/configuration.rb

@@ -0,0 +1,8 @@
+class Configuration
+  attr_accessor :business_key, :agent_key
+
+  def initialize
+    @business_key = 'your_business_key'
+    @agent_key    = 'your_agent_key'
+  end
+end

data/lib/licencetobill/deal.rb

@@ -0,0 +1,5 @@
+module LicenceToBill
+  class Deal
+    include LicenceToBill::Concerns
+  end
+end

data/lib/licencetobill/feature.rb

@@ -0,0 +1,5 @@
+module LicenceToBill
+  class Feature
+    include LicenceToBill::Concerns
+  end
+end

data/lib/licencetobill/helpers.rb

@@ -0,0 +1,5 @@
+module LicenceToBill::Helpers
+  def get_collection(klass, api_call)
+    LicenceToBill::Manager.return_collection(klass, api_call)
+  end
+end

data/lib/licencetobill/manager.rb

@@ -0,0 +1,13 @@
+module LicenceToBill
+  class Manager
+    def self.return_collection(klass, params)
+      if params.kind_of?(Array)
+        params.map { |hash| klass.new(hash) }
+      else
+        return [] if params.parsed_response['Status'] === 404
+        params = JSON.parse(params.body)
+        [klass.new(params)]
+      end
+    end
+  end
+end

data/lib/licencetobill/offer.rb

@@ -0,0 +1,9 @@
+module LicenceToBill
+  class Offer
+    include LicenceToBill::Concerns
+
+    def get_stages
+      get_collection(LicenceToBill::Stage, self.stages)
+    end
+  end
+end

data/lib/licencetobill/stage.rb

@@ -0,0 +1,9 @@
+module LicenceToBill
+  class Stage
+    include LicenceToBill::Concerns
+
+    def get_features
+      get_collection(LicenceToBill::Feature, self.features) 
+    end
+  end
+end

data/lib/licencetobill/user.rb

@@ -0,0 +1,5 @@
+module LicenceToBill
+  class User
+    include LicenceToBill::Concerns
+  end
+end

data/lib/licencetobill/user_address.rb

@@ -0,0 +1,5 @@
+module LicenceToBill
+  class UserAddress
+    include LicenceToBill::Concerns
+  end
+end

data/lib/licencetobill.rb

@@ -0,0 +1,21 @@
+module LicenceToBill
+  def self.root
+    File.dirname __dir__
+  end
+end
+
+require 'json'
+require 'httparty'
+require 'vcr'
+
+require_relative 'licencetobill/configuration'
+require_relative 'licencetobill/helpers'
+require_relative 'licencetobill/api'
+require_relative 'licencetobill/concerns'
+require_relative 'licencetobill/deal'
+require_relative 'licencetobill/feature'
+require_relative 'licencetobill/manager'
+require_relative 'licencetobill/offer'
+require_relative 'licencetobill/stage'
+require_relative 'licencetobill/user'
+require_relative 'licencetobill/user_address'

data/spec/api_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe LicenceToBill::API do  
+
+  before { @api = LicenceToBill::API.new }
+
+  describe 'Users' do
+    it '#get_users', :vcr do
+      users = @api.get_users
+      user  = users.first
+      expect(users).to be_a(Array)
+      expect(user).to be_a(LicenceToBill::User) if user
+    end
+
+    it '#get_user', :vcr do
+      user = @api.get_user(1)
+      expect(user).to be_a(LicenceToBill::User) if user
+    end
+
+    it '#get_user_for', :vcr do
+      key_feature = @api.get_features.first.key_feature
+      users       = @api.get_users_for(key_feature)
+      user        = users.first
+      expect(users).to be_a(Array)
+      expect(user).to be_a(LicenceToBill::User) if user
+    end
+
+    it '#get_billing_address_for', :vcr do
+      user    = @api.get_users.select{|u| u.key_user == '1'}.first
+      address = @api.get_billing_address_for(user.key_user)
+      expect(address).to be_a(LicenceToBill::UserAddress) if address
+      expect(user.name_user).to eq(address.fullname) if address
+    end
+  end
+
+  describe 'Features' do
+    it '#get_features', :vcr do
+      features = @api.get_features
+      feature = features.first
+      expect(features).to be_a(Array)
+      expect(feature).to be_a(LicenceToBill::Feature) if feature
+    end
+
+    it '#get_features_for', :vcr do
+      user = @api.get_user(1)
+      features = @api.get_features_for(user.key_user)
+      feature = features.first
+      expect(features).to be_a(Array)
+      expect(feature).to be_a(LicenceToBill::Feature) if feature
+    end
+
+    it '#get_features_details_for', :vcr do
+      user = @api.get_user(1)
+      features = @api.get_features
+      feature = features.first
+      restriction = @api.get_features_details_for(feature.key_feature, user.key_user)
+      expect(features).to be_a(Array)
+      expect(feature).to be_a(LicenceToBill::Feature) if feature
+    end
+  end
+
+  describe 'Offers' do
+    it '#get_offers', :vcr do
+      offers = @api.get_offers
+      offer = offers.first
+      expect(offers).to be_a(Array)
+      expect(offer).to be_a(LicenceToBill::Offer) if offer
+    end
+
+    it '#get_offers_for', :vcr do
+      user = @api.get_user(1)
+      offers = @api.get_offers_for(user.key_user)
+      offer = offers.first
+      expect(offers).to be_a(Array)
+      expect(offer).to be_a(LicenceToBill::Offer) if offer
+    end
+
+    it '#features', :vcr do
+      user = @api.get_user(1)
+      offers = @api.get_offers_for(user.key_user)
+      offer = offers[1]
+      expect(offer.features).to be_a(Array)
+      expect(offer.features.first).to be_a(LicenceToBill::Feature) if offer
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'utilities'
+require 'webmock/rspec'
+require 'licencetobill' # and any other gems you need
+Bundler.setup
+
+RSpec.configure do |config|
+  config.around(:each, :vcr) do |example|
+    name = example.metadata[:full_description].split(/\s+/)[-1]
+    VCR.use_cassette(name) { example.call }
+  end
+end

data/spec/utilities.rb

@@ -0,0 +1,3 @@
+def resources_path(file)
+  "#{LicenceToBill.root}/spec/resources/#{file}"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: licencetobill
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Troppée
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: 
+email: gtroppee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Gemfile
+- spec/api_spec.rb
+- spec/spec_helper.rb
+- spec/utilities.rb
+- lib/licencetobill/api.rb
+- lib/licencetobill/concerns.rb
+- lib/licencetobill/configuration.rb
+- lib/licencetobill/deal.rb
+- lib/licencetobill/feature.rb
+- lib/licencetobill/helpers.rb
+- lib/licencetobill/manager.rb
+- lib/licencetobill/offer.rb
+- lib/licencetobill/stage.rb
+- lib/licencetobill/user.rb
+- lib/licencetobill/user_address.rb
+- lib/licencetobill.rb
+homepage: http://rubygems.org/gems/licencetobill
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A simple ruby wrapper for the LicenceToBill API
+test_files: []
+has_rdoc: