openbill-ruby 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e8d41cf49c4b4c79c67648a13bb8d620021fdff
-  data.tar.gz: cefc16e4aa3aaa1a0f64c1da0048e9ea30a7ff8b
+  metadata.gz: 1e596b1c45d1e6de254938e905bbf454058bf7df
+  data.tar.gz: 9b6bfc5f5e89ac5c1479e3f3de6e4aba3ecc1619
 SHA512:
-  metadata.gz: b2b78ea598a78806137e6844fb7fcd35526dcaac3791ac53c2cadc34dc06972a580c0908a2421a5466a79887d94c6e9e01f93e687a56c29f1c1d912e02caaa86
-  data.tar.gz: 6053481084ad0b63af80a33c881e380281b054f1616f00a2c26e0bc2105b27b8a4fc813234378d3be5347a0d78c066ef0c9e8511ba9b40279d85149c018388fd
+  metadata.gz: 2a27ab2112aed4d8f0fbf228d5570cacdb7d1ea71eee4e9927e90e07b90f0dc4e9e4deea520b0dcdaf6dd46552df1abdbb609632051023d2f3817f8890294e55
+  data.tar.gz: 023a1cf6968b662d6337aff8aa0a2b97077a01b9d31601b5b9f5d2a7324af27a4b6396a033c8130a2e92f43f6765ea256e9184cc2bc360b875eb9080cd8c318c

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
+addons:
+  postgresql: "9.5"
+services:
+  - postgresql
 rvm:
-  - 2.2.2
+  - 2.2.1
+sudo: false
+cache: bundler
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -20,50 +20,26 @@ Migrate database:
 
 Add database configurartion to `./config/initializers/openbill.rb`
 
-```ruby
-Openbill.config.database = ActiveRecord::Base.connection.instance_variable_get('@config');
-```
-
 ## Usage
 
 ### Создание системных счетов
 
-
-Рекомендую создать такой сервис для работы с системными счетами:
-
 ```ruby
-module Billing
-  NS = :system
-
-  class << self
-    def payments
-      account :payments, 'Счет с которого поступает оплата'
-    end
+Openbill.config.database = 
+  ActiveRecord::Base.connection.instance_variable_get('@config');
 
-    def subscriptions
-      account :subscriptions, 'Абонентская плата'
-    end
 
-    private
-
-    # Находит, или создает аккаунт с указанным именем
-    #
-    def account(path, details)
-      # Создаем uri аккаунта из его названия
-      uri = Openbill.generate_uri NS, path
-
-      Openbill.get_account_by_uri(uri) ||
-        Openbill.create_account(uri, details: details)
-    end
-  end
+SystemRegistry = Openbill::Registry.new Openbill.current do |registry|
+  registry.define :payments,      'Счет с которого поступает оплата'
+  registry.define :subscriptions, 'Абонентская плата'
 end
 ```
 
-Таким образом в системе появляется два счета `Billing.payments` и `Billing.subscriptions`
+Таким образом в системом реестре появляется два счета `SystemRegistry[:payments]` и `SystemRegistry[:subscriptions]`
 
 ### Поддержка биллинга со стороны клиента (автоматическое создание клиентского счета):
 
-```
+```ruby
 module AccountBilling
   extend ActiveSupport::Concern
 
@@ -74,21 +50,7 @@ module AccountBilling
   delegate :amount, to: :billing_account
 
   def billing_account
-    find_billing || attach_billing
-  end
-
-  private
-
-  def account_uri
-    Openbill.generate_uri :accounts, id
-  end
-
-  def find_billing
-    Openbill.current.get_account_by_uri account_uri
-  end
-
-  def attach_billing
-    Openbill.current.create_account account_uri
+    Openbill.current.account([:accounts, id])
   end
 end
 ```
@@ -102,10 +64,22 @@ end
 
 ```ruby
 Openbill.current.make_transaction(
+  // Счет списания
   from_account_id: Billing.payment.id,
+
+  // Счет зачисление
   to_account_id:   user.billing_account.id,
-  amount:          Money(123),
+  
+  // Уникальный идентификатор транзакции
+  uri:             Openbill.current.generate_uri(:transactions, 123),
+
+  // Сумма транзакции. Валюта должна совпадать с обоими счетами
+  amount:          Money(123, 'RUB'),
+
+  // Не обязательное текстовое описание транзакции
   details:         'Оплата такая-то',
+
+  // hash с данными транзакции для структурированного поиска в дальнейшем
   meta:            { key: 'value' } // не обязательно
 )
 ```

data/lib/openbill.rb

@@ -4,6 +4,8 @@ module Openbill
   autoload :Account,       'openbill/account'
   autoload :Transaction,   'openbill/transaction'
   autoload :Configuration, 'openbill/configuration'
+  autoload :Registry,      'openbill/registry'
+  autoload :Database,      'openbill/database'
 
   ACCOUNTS_TABLE_NAME     = :openbill_accounts
   TRANSACTIONS_TABLE_NAME = :openbill_transactions
@@ -21,16 +23,10 @@ module Openbill
       Configuration.instance
     end
 
-    def generate_uri(resource, id)
-      "obp://local/#{resource}/#{id}"
-    end
-
-    def create_connection(&block)
-      @create_connection_block = block
-    end
-
     def current
-      @current ||= Openbill::Service.new config.database
+      return @current if @current
+
+      @current = Openbill::Service.new config
     end
   end
 end

data/lib/openbill/configuration.rb

@@ -1,7 +1,15 @@
 require 'singleton'
 
 class Configuration
+  DEFAULT_CURRENCY = 'USD'.freeze
+
   include Singleton
 
   attr_accessor :database
+
+  attr_writer :default_currency
+
+  def default_currency
+    @default_currency || DEFAULT_CURRENCY
+  end
 end

data/lib/openbill/database.rb

@@ -0,0 +1,14 @@
+module Openbill
+  class Database
+    MAX_CONNECTIONS         = 10
+
+    def initialize(db_config)
+      @db_config = db_config
+      @db = Sequel.connect db_config, logger: logger, max_connections: MAX_CONNECTIONS
+      @db.extension :pagination
+      @db.extension :pg_hstore
+    end
+
+    delegate :logger, to: Rails
+  end
+end

data/lib/openbill/registry.rb

@@ -0,0 +1,36 @@
+module Openbill
+  class Registry
+    SYSTEM_NS = :system
+    AccountNotFound = Class.new StandardError
+
+    def initialize(service, system_ns = SYSTEM_NS)
+      fail("Must be a Openbill::Service #{service}") unless service.is_a? Openbill::Service
+      @service = service
+      @system_ns = system_ns
+      @accounts = {}
+      yield self
+      @accounts.freeze
+      return @accounts
+    rescue
+      @system_ns = nil
+    end
+
+    # Находит, или создает аккаунт с указанным именем
+    #
+    def define(name, options)
+      @accounts[name] = service.account([system_ns, name], options)
+    end
+
+    def [](name)
+      @account[name]
+    end
+
+    def find(name)
+      [name] || raise(AccountNotFound, name)
+    end
+
+    private
+
+    attr_reader :service, :system_ns
+  end
+end

data/lib/openbill/service.rb

@@ -3,25 +3,42 @@ require 'uri'
 require 'money'
 
 module Openbill
-  MAX_CONNECTIONS         = 10
-  DEFAULT_CURRENCY        = 'RUB'.freeze
 
   class Service
-    def initialize(db_config)
-      init_db db_config
+    PROTO = 'obp'.freeze
+    HOST = 'local'.freeze
+
+    def initialize(config)
+      @config = config
+      @database = Openbill::Database.new config.database
+    end
+
+    def generate_uri(resource, id)
+      "#{PROTO}://#{HOST}/#{resource}/#{id}"
+    end
+
+    # @param uri - uri аккаунта в виде строки: "odp://local/resource/id"
+    #              или в виде массива [resource, id]
+    #
+    # @param options - опции применяемые для создания аккаунта (см create_account)
+    #
+    def account(uri, options = {})
+      uri = prepare_uri uri
+      get_account_by_uri(uri) || create_account(uri, options)
     end
 
     def get_account_by_uri(uri)
+      uri = prepare_uri uri
       Openbill::Account[uri: uri]
     end
 
-    def create_account(uri, currency: DEFAULT_CURRENCY, details: nil, meta: {})
+    def create_account(uri, currency: nil, details: nil, meta: {})
       uri = prepare_uri uri
       Openbill::Account.create(
         uri:             uri,
         details:         details,
         meta:            meta,
-        amount_currency: currency
+        amount_currency: currency || config.default_currency
       )
     end
 
@@ -43,25 +60,19 @@ module Openbill
 
     private
 
-    attr_reader :db_config, :db
+    attr_reader :database, :config
 
     delegate :logger, to: Rails
 
     def prepare_amount(amount)
       return amount if amount.is_a? Money
-      return Money.new(amount, DEFAULT_CURRENCY) if amount.is_a? Fixnum
+      return Money.new(amount, config.default_currency) if amount.is_a? Fixnum
       raise "amount parameter (#{amount}) must be a Money or a Fixnum"
     end
 
     def prepare_uri(uri)
+      uri = generate_uri uri.first, uri.second if uri.is_a? Array
       URI(uri).to_s # Парсим и валидируем заодно
     end
-
-    def init_db(db_config)
-      @db_config = db_config
-      @db = Sequel.connect db_config, logger: logger, max_connections: MAX_CONNECTIONS
-      @db.extension :pagination
-      @db.extension :pg_hstore
-    end
   end
 end

data/lib/openbill/version.rb

@@ -1,3 +1,3 @@
 module Openbill
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openbill-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Danil Pismenny
@@ -73,7 +73,9 @@ files:
 - lib/openbill.rb
 - lib/openbill/account.rb
 - lib/openbill/configuration.rb
+- lib/openbill/database.rb
 - lib/openbill/engine.rb
+- lib/openbill/registry.rb
 - lib/openbill/service.rb
 - lib/openbill/transaction.rb
 - lib/openbill/version.rb