adkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc696a7e1180684bd2ceb9a5de358491c7eb4d9a19e8b1fe8e4c3c56d2a05e6d
+  data.tar.gz: adc654e90b4c0cac33502c4f1549623557a7dd064490329f3bd2716d9a2b0269
+SHA512:
+  metadata.gz: a949fb700fa2257c80b7340a5c0b45bd3312f3c55ccc594379299b0af0e6084e08c8d57a6de2f068793f0b73ab48d0c1e8b9e45cfb01305143957ddb24ddcd97
+  data.tar.gz: 4ffe3538e86df6a1fa84626877fac15f2bf6c170c17646b10106ab156ecd8ab97e5cffe05d5dd2fe98fa3faffccddd0f50b4865662f152f10253ffe41e24037f

data/.gitignore

@@ -0,0 +1,12 @@
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.vagrant/
+/ubuntu-xenial-16.04-cloudimg-console.log

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 / 2020-07-28
+
+* Initial release!

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sean Walker
+
+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,85 @@
+# adkit
+
+Easy marketing calculations
+
+## Conversion Rate
+
+```ruby
+total = 1_000
+conversions = 15
+
+Adkit.conversion_rate(total, conversions) # => 1.5
+
+# or if you like acronyms
+Adkit.cvr(total, conversions) # => 1.5
+```
+
+## Lift
+
+```ruby
+total = 1_000
+conversions = 30
+
+control = 100
+control_conversions = 1
+
+Adkit.lift(total, conversions, control, control_conversions) # => 200.0
+```
+
+## Cost Per Action
+
+```ruby
+cost = 9_876
+conversions = 1_000
+
+Adkit.cost_per_action(cost, conversions) # => 10.0
+
+# or
+
+Adkit.cpa(cost, conversions) # => 10.0
+```
+
+## Incremental Cost Per Action
+
+```ruby
+total = 5_000
+cost = 100
+conversions = 1_000
+control = 100
+control_conversions = 5
+
+Adkit.incremental_cpa(total, cost, conversions, control, control_conversions) # => 0.1333333
+
+# or
+
+Adkit.cpia(total, cost, conversions, control, control_conversions) # => 0.1333333
+
+# or
+
+Adkit.icpa(total, cost, conversions, control, control_conversions) # => 0.1333333
+```
+
+## Average Order Value
+
+```ruby
+revenue = 123_456
+conversions = 345
+
+Adkit.average_order_value(revenue, conversions) # => 357.8434782608696
+
+# or
+
+Adkit.aov(revenue, conversions) # => 357.8434782608696
+```
+
+## Return on Ad Spend
+
+```ruby
+revenue = 12_345
+cost = 987
+
+Adkit.return_on_ad_spend(revenue, cost) # =>  1250.759878419453
+
+# or
+Adkit.roas(revenue, cost)
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/Vagrantfile

@@ -0,0 +1,32 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Provisioning script
+$script = <<SCRIPT
+  echo "*** Updating packages"
+  sudo DEBIAN_FRONTEND=noninteractive apt-get install -y aptitude
+  sudo DEBIAN_FRONTEND=noninteractive aptitude update
+  sudo DEBIAN_FRONTEND=noninteractive aptitude -y safe-upgrade
+  echo "*** Installing new packages"
+  sudo DEBIAN_FRONTEND=noninteractive aptitude install -y curl git-core vim
+  if rvm -v 2>/dev/null; then
+    echo "*** rvm already installed, skipping"
+  else
+    echo "*** Installing rvm"
+    gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
+    curl -sSL https://get.rvm.io | bash -s stable --ruby
+    echo "gem: --no-document" > ~/.gemrc
+    echo "*** Finished installing rvm"
+  fi
+  echo "*********************"
+  echo "PROVISIONING FINISHED"
+  echo "*********************"
+SCRIPT
+
+
+Vagrant.configure('2') do |config|
+  config.vm.box      = 'ubuntu/xenial64'
+  config.vm.hostname = 'adkit-dev'
+
+  config.vm.provision 'shell', inline: $script, privileged: false
+end

data/adkit.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adkit'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adkit'
+  spec.version       = Adkit::VERSION
+  spec.authors       = ["Sean Walker"]
+  spec.email         = [""]
+
+  spec.summary       = %q{Easy marketing calculations}
+  spec.description   = %q{A bundle of common marketing calculations}
+  spec.homepage      = "https://github.com/swlkr/adkit"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/swlkr/adkit"
+    spec.metadata["changelog_uri"] = "https://github.com/swlkr/adkit/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.4'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/adkit.rb

@@ -0,0 +1,67 @@
+module Adkit
+  VERSION = '0.1.0'.freeze
+
+  class << self
+    def cvr(total, conversions)
+      if total.zero?
+        0.0
+      else
+        100.0 * conversions / total.to_f
+      end
+    end
+
+    alias conversion_rate cvr
+
+    def lift(total, conversions, control, control_conversions)
+      real_cvr = cvr(total, conversions)
+      control_cvr = cvr(control, control_conversions)
+
+      if control_cvr.zero?
+        0.0
+      else
+        100.0 * (real_cvr - control_cvr) / control_cvr
+      end
+    end
+
+    def cpa(cost, conversions)
+      if conversions.zero?
+        0.0
+      else
+        cost / conversions.to_f
+      end
+    end
+
+    alias cost_per_action cpa
+
+    def incremental_cpa(total, cost, conversions, control, control_conversions)
+      if control.zero?
+        0.0
+      else
+        cpa(cost.to_f, conversions.to_f - (control_conversions.to_f * (total.to_f / control)))
+      end
+    end
+
+    alias cpia incremental_cpa
+    alias icpa incremental_cpa
+
+    def aov(revenue, conversions)
+      if conversions.zero?
+        0.0
+      else
+        revenue / conversions.to_f
+      end
+    end
+
+    alias average_order_value aov
+
+    def roas(revenue, cost)
+      if cost.zero?
+        0.0
+      else
+        100.0 * revenue / cost.to_f
+      end
+    end
+
+    alias return_on_ad_spend roas
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: adkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Walker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A bundle of common marketing calculations
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- adkit.gemspec
+- lib/adkit.rb
+homepage: https://github.com/swlkr/adkit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/swlkr/adkit
+  source_code_uri: https://github.com/swlkr/adkit
+  changelog_uri: https://github.com/swlkr/adkit/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Easy marketing calculations
+test_files: []