openbill-ruby 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b81bdc0ec906d8dd0d12577772d4a6bd3c4eabce
-  data.tar.gz: f79967c83942d3f7e15df4cb5e62b2ba89048193
+  metadata.gz: 2e8d41cf49c4b4c79c67648a13bb8d620021fdff
+  data.tar.gz: cefc16e4aa3aaa1a0f64c1da0048e9ea30a7ff8b
 SHA512:
-  metadata.gz: bc1d4999a0428e9e23ca906417a0e9f7a3891699b1884636c79f9bbc02733f0265b7d01bb1587aa4c9335dea06618134ebbb5e8e8ba9f680239e690bdb98c795
-  data.tar.gz: ec4e573a1ff094828af7870f493bf252314d6133182f20e32c13f37ecba2d4a7dbd7692c2efde3a3f1bcc5161ea2f592cf05a7fcaca4da6422a16e5e04e263f7
+  metadata.gz: b2b78ea598a78806137e6844fb7fcd35526dcaac3791ac53c2cadc34dc06972a580c0908a2421a5466a79887d94c6e9e01f93e687a56c29f1c1d912e02caaa86
+  data.tar.gz: 6053481084ad0b63af80a33c881e380281b054f1616f00a2c26e0bc2105b27b8a4fc813234378d3be5347a0d78c066ef0c9e8511ba9b40279d85149c018388fd

data/README.md

@@ -1,34 +1,114 @@
 # Openbill
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/openbill`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Это модуль для биллиноговой системы [openbill-core](https://github.com/dapi/openbill-core).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'openbill'
+gem 'openbill-ruby'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Migrate database:
+
+    $ rake db:migrate
+
+Add database configurartion to `./config/initializers/openbill.rb`
+
+```ruby
+Openbill.config.database = ActiveRecord::Base.connection.instance_variable_get('@config');
+```
+
+## Usage
+
+### Создание системных счетов
 
-    $ gem install openbill
 
+Рекомендую создать такой сервис для работы с системными счетами:
 
+```ruby
+module Billing
+  NS = :system
 
-    Openbill.create_connection do
-      new ActiveRecord::Base.connection.instance_variable_get('@config')
+  class << self
+    def payments
+      account :payments, 'Счет с которого поступает оплата'
     end
 
-## Usage
+    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
+end
+```
+
+Таким образом в системе появляется два счета `Billing.payments` и `Billing.subscriptions`
 
-TODO: Write usage instructions here
+### Поддержка биллинга со стороны клиента (автоматическое создание клиентского счета):
+
+```
+module AccountBilling
+  extend ActiveSupport::Concern
+
+  included do
+    after_commit :attach_billing, on: :create
+  end
+
+  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
+  end
+end
+```
+
+Добавляем concern в модель ответсвенную за счет (например в User)
+
+
+### Прием оплаты.
+
+Оплата проводится транзакцией между системным счетом `payments` и счетом клиента.
+
+```ruby
+Openbill.current.make_transaction(
+  from_account_id: Billing.payment.id,
+  to_account_id:   user.billing_account.id,
+  amount:          Money(123),
+  details:         'Оплата такая-то',
+  meta:            { key: 'value' } // не обязательно
+)
+```
 
 ## Development
 

data/lib/openbill/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openbill-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Danil Pismenny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler