auctify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c19c38113580070b4a0e6d9914b22c042fb3024e2a96193a7004fd61859985c3
+  data.tar.gz: '080f74640d3c40935a0faf304c120cb294e896e000ffa1cc822a769d077f3fbf'
+SHA512:
+  metadata.gz: b5dc577b91bd6ba035187bbf272f52f744a6ee7832c90c998e27c7eb63324c98b7bfa1eecb259f21522d0dae8accde3ef112a8166d58bc2ece2a6cbfd6edafa2
+  data.tar.gz: 67f7b5f692569e542eaa5a59727e15c9e602a1d022c69156046acf7e343f4f5acecad42b1e7adfd44bc8b7bb317dcd293bb5aec7c4d9d6e28078b829e24dd8b7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 foton
+
+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,229 @@
+# Auctify
+Rails engine for auctions of items. Can be used on any ActiveRecord models.
+
+## Objects
+- `:item` - object/model, which should be auctioned (from `main_app`)
+- `:user` - source for `seller`, `owner`, `buyer` and `bidder` (from `main_app`)
+- `sale` - sale of `:item`; can be direct `retail`, by `auction` or some other type
+- `auction` for one `:item` (it is [Forward auction](https://en.wikipedia.org/wiki/Forward_auction)) (v češtině "Položka aukce")
+- `seller` - person/company which sells `:item` in specific `sale`
+- `bidder` - registered person/user allowed to bid in specific `auction`
+- `buyer` - person/company which buys `:item` in specific `sale` ( eg. winner of auction)
+- `bid` - one bid of one `bidder` in `auction`
+- `sales_pack` - pack of sales(auctions), mostly time framed, Can have physical location or be online. (v češtině "Aukce")
+- `auctioneer` - (needed?) company organizing `auction`
+
+## Relations
+- `:item` 1 : 0-N `sale`, (sale time periods cannot overlap)
+- `:item` N : 1 `owner` (can change in time)
+- `sale` N : 1 `seller`
+- `sale` N : 1 `buyer`
+- `sale::auction` 1 : N `bidders` (trough `bidder_registrations`) 1 : N `bids`
+- `sales_pack` 0-1 : N `sales`  (`sales_pack` is optional for `sale`)
+- `auction` N : 1 `auctioneer` (?)
+
+
+## Classes
+###  Sales
+ - `Sale::Auction` - full body auction of one item for many registered  buyer (as bidders)
+ - `Sale::Retail` - direct sale of item to one buyer
+
+## TODO
+- generator to copy auction's views to main app (so they can be modified) (engine checks main_app views first)
+
+
+
+## Notices
+`sale belongs_to item`  polymorphic , STI typed
+`sale belongs_to seller`  polymorphic
+`sale belongs_to buyer`  polymorphic
+`auction has_many bidder_registrations` (?bidders?)
+`bidder_registration belongs buyer` polymorphic
+
+If `item.owner` exists, it is used as `auction.seller` (or Select from all aucitfied sellers)
+
+## Features required
+
+- if bidder adds bid in `:prolonging_limit` minutes before auction ends, end time is extended for `bid.time + prolonging_limit` (so auction end when there are no bids in last `:prolonging_limit` minutes)
+- for each auction, there can be set of rules for minimal `bid` according to current `auctioned_price` (default can be `(1..Infinity) => 1`)
+  real example
+  ```
+  minimal_bids = {
+    (0...5_000) => 100,
+    (5_000...20_000) => 500,
+    (20_000...100_000) => 1_000,
+    (100_000...500_000) => 5_000,
+    (500_000...1_000_000) => 10_000,
+    (1_000_000...2_000_000) => 50_000,
+    (2_000_000..) => 100_000
+    }
+  ```
+- first bid do not increase `auctioned_price` it stays on `base_price`
+- bidder cannot "overbid" themselves (no following bids from same bidder)
+- auctioneer can define format of auction numbers (eg. "YY#####") and sales_pack numbers
+- there should be ability to follow `auction` (notification before end) or `item.author` (new item in auction)
+- item can have category and user can select auction by categories.
+- SalePack can be `(un)published /public`
+- SalePack can be `open (adding items , bidding)/ closed(bidding ended)`
+- auctioneer_commission is in % and adds to sold_price in checkout
+- auction have `start_time` and `end_time`
+- auction can be `highlighted` for cover pages
+- auction stores all bids history even those cancelled by admin
+- there should be two types of bid
+   - one with maximal price (amount =>  maximal bid price; placed in small bids as needed), system will increase bid automagicaly unless it reaches maximum
+   - second direct bid (amount => bid price; immediattely placed)
+- sales numbering: YY#### (210001, 210002, …, 259999)
+
+
+
+
+
+## Usage
+In `ActiveRecord` model use class method `auctify_as` with params `:buyer`,`:seller`, `:item`.
+```ruby
+class User < ApplicationRecord
+  auctify_as :buyer, :seller # this will add method like `sales`, `puchases` ....
+end
+
+class Painting < ApplicationRecord
+  auctify_as :item # this will add method like `sales` ....
+end
+```
+`Auctify` expects that auctifyied model instances responds to `to_label` and `:item` to reponds to `owner` (which should lead to object auctified as `:seller`)!
+
+## Installation
+  1. ### Add gem
+      Add this line to your application's Gemfile:
+
+      ```ruby
+      gem 'auctify'
+      ```
+
+      And then execute:
+      ```bash
+      $ bundle
+      ```
+
+      Or install it yourself as:
+      ```bash
+      $ gem install auctify
+      ```
+
+  2. ### Auctify classes
+      ```ruby
+      class User < ApplicationRecord
+        auctify_as :buyer, :seller # this will add method like `sales`, `puchases` ....
+      end
+
+      class Painting < ApplicationRecord
+        auctify_as :item # this will add method like `sales` ....
+      end
+      ```
+
+  3. ### Configure
+      - optional
+      ```ruby
+        Auctify.configure do |config|
+          config.autoregister_as_bidders_all_instances_of_classes = ["User"] # default is []
+          config.auction_prolonging_limit = 10.minutes # default is 1.minute
+          config.auctioneer_commission_in_percent = 10 # so buyer will pay: auction.current_price * ((100 + 10)/100)
+          config.autofinish_auction_after_bidding = true # after `auction.close_bidding!` immediatelly proces result to `auction.sold_in_auction!` or `auction.not_sold_in_auction!`; default false
+          config.when_to_notify_bidders_before_end_of_bidding = 30.minutes # default `nil` => no notifying
+          config.restrict_overbidding_yourself_to_max_price_increasing = false # default is `true` so only bids with `max_price` can be applied if You are winner.
+        end
+      ```
+
+      If model autified as `:buyer` responds to `:bidding_allowed?` , check is done before each `auction.bid!`. Also if `buyer.bidding_allowed? => true` , registration to auction is created on first bid.
+  4. ### Callbacks
+    For available auction callback methods to override see `app/concerns/auctify/sale/auction_callbacks.rb`
+
+
+  5. ### Use directly
+      ```ruby
+        banksy = User.find_by(nickname: "Banksy")
+        bidder1 = User.find_by(nickname: "Bidder1")
+        bidder2 = User.find_by(nickname: "Bidder2")
+        piece = Painting.find_by(title: "Love is in the bin")
+
+        piece.owner == banksy # => (not actually) :true
+
+        auction = banksy.offer_to_sale!(piece, { in: :auction, price: 100 })
+
+        auction.offered? # => :true
+        auction.item == piece # => :true
+        auction.seller == banksy # => :true
+        auction.offered_price # => 100.0
+
+        banksy.sales # => [auction]
+        banksy.auction_sales # => [auction]
+        banksy.retail_sales # => []
+
+        pieces.sales # => [auction]
+
+        auction.bidder_registrations # => []   unless config.autoregister_as_bidders_all_instances_of_classes is set
+        auction.bidder_registrations.create(bidder: bidder1) # => error, not allowed ("Aukce aktuálně nepovoluje nové registrace")
+
+        auction.accept_offer!
+
+        b1_reg = auction.bidder_registrations.create(bidder: bidder1)
+        b2_reg = auction.bidder_registrations.create(bidder: bidder2)
+
+        auction.bidder_registrations.size # => 2
+        auction.current_price # => nil
+
+        auction.start_sale!
+        auction.current_price # => 100.0
+
+        aucion.bid!(Auctify::Bid.new(registration: b1_reg, price: nil, max_price: 150))
+        # auction.bid_appended! is called after succesfull bid, You can override it
+        # auction.bid_not_appended!(errors) is called after unsuccesfull bid, You can override it
+
+        auction.current_price # => 100.0
+        auction.bidding_result.winner # => bidder1
+        auction.bidding_result.current_price # => 100.0
+        auction.bidding_result.current_minimal_bid # => 101.0    `auction.bid_steps_ladder` is empty, we increasing by 1
+
+        aucion.bid!(Auctify::Bid.new(registration: b2_reg, price: 145, max_price: nil))
+        # some auto bidding is done
+        auction.current_price # => 146.0
+        auction.bidding_result.winner # => bidder1
+        auction.bidding_result.current_price # => 146.0
+        auction.bidding_result.current_minimal_bid # => 147.0
+        auction.winner # => nil
+
+        aucion.bid!(Auctify::Bid.new(registration: b2_reg, price: 149, max_price: 155))
+        # some auto bidding is done
+        auction.current_price # => 151.0
+        auction.bidding_result.winner # => bidder2
+        auction.bidding_result.current_price # => 151.0
+        auction.bidding_result.current_minimal_bid # => 152.0
+
+        auction.close_bidding!
+        auction.bidding_ended? # => true
+        auction.buyer # => nil
+        auction.winner # => bidder2
+
+        auction.sold_in_auction!(buyer: bidder2, price: 149, sold_at: currently_ends_at)  # it is verified against bids!
+
+        auction.auctioned_successfully? # => true
+        auction.buyer # => bidder2
+
+        # when all negotiations went well
+        auction.sell!
+
+        auction.sold? # => true
+      ```
+
+      Look into tests `test/models/auctify/sale/auction_bidding_test.rb` and `test/services/auctify/bid_appender_test.rb` for more info about bidding process.
+
+      To protect accidential deletions, many associations are binded with `dependent: restrict_with_error`. Correct order ofdeletion is `bids` => `sales` => `sales_packs`.
+
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Auctify"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/auctify_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/auctify .css

data/app/assets/javascripts/folio/console/main_app.coffee

@@ -0,0 +1 @@
+# Override in main app

data/app/assets/stylesheets/auctify/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/auctify/bidder_registrations.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/auctify/bids.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/auctify/sales.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/auctify/sales_packs.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/folio/console/_main_app.sass

@@ -0,0 +1 @@
+// Override in main app

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/app/cells/folio/console/atoms/previews/main_app.coffee

@@ -0,0 +1 @@
+# Override in main app

data/app/concerns/auctify/behavior/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Auctify
+  module Behavior
+    module Base
+      extend ActiveSupport::Concern
+
+      def auctify_id
+        "#{self.class.name}@#{id}"
+      end
+
+      def object_from_auctify_id(auctify_id)
+        return nil if auctify_id.blank?
+
+        klass, id = auctify_id.to_s.split("@")
+        klass.constantize.find(id)
+      end
+    end
+  end
+end