purchase 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Rossmeissl
+
+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.markdown

@@ -0,0 +1,17 @@
+# purchase
+
+Description goes here.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Andy Rossmeissl. See LICENSE for details.

data/features/purchase_committees.feature

@@ -0,0 +1,20 @@
+Feature: Purchase Committee Calculations
+  The purchase model should generate correct committee calculations
+
+  Scenario Outline: Standard Calculations for 
+    Given a flight has "origin_airport.iata_code" of "<source>"
+    And it has "destination_airport.iata_code" of "<dest>"
+    And it has "airline.iata_code" of "<airline>"
+    And it has "date" of "<date>"
+    And it used "aircraft.icao_code" "<aircraft>"
+    When emissions are calculated
+    Then the fuel committee should be close to <fuel>, +/-1
+    And the fuel_per_segment committee should be close to <fuel_per_segment>, +/-10
+    And the adjusted_distance_per_segment committee should be close to <adjusted_distance_per_segment>, +/-1
+    And the load_factor committee should be close to <load_factor>, +/-0.001
+    And the passengers committee should be exactly <passengers>
+    And the adjusted_distance committee should be close to <adjusted_distance>, +/-1
+    Examples:
+      | source | dest | airline | date       | aircraft | fuel  | fuel_per_segment | adjusted_distance_per_segment | load_factor | passengers | adjusted_distance |
+      | DTW    | SFO  | UA      | 2010-06-25 | A320     | 24676 | 7612             | 1341                          | 0.788       | 118        | 2241              |
+      | IAD    | CDG  | AF      | 2010-06-25 | A320     | 43477 | 13413            | 2492                          | 0.800       | 120        | 4161              |

data/features/purchase_emissions.feature

@@ -0,0 +1,11 @@
+Feature: Purchase Emissions Calculations
+  The purchase model should generate correct emission calculations
+
+  Scenario Outline: Standard Calculations for a MCC
+    Given a purchase has "merchant_category_code" of "<mcc>"
+    When emissions are calculated
+    Then the emission value should be within 1 kgs of <emission>
+    Examples:
+      | mcc  | emission |
+      | 1771 | 1153     |
+      | 3007 | 2070     |

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.setup
+
+require 'cucumber'
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+
+require 'sniff'
+Sniff.init File.join(File.dirname(__FILE__), '..', '..'), :earth => :all

data/lib/purchase/carbon_model.rb

@@ -0,0 +1,70 @@
+require 'leap'
+require 'timeframe'
+
+module BrighterPlanet
+  module Purchase
+    module CarbonModel
+      def self.included(base)
+        base.extend ::Leap::Subject
+        base.extend FastTimestamp
+        base.decide :emission, :with => :characteristics do
+          committee :emission do |provides|
+            provides.quorum :from_emission_factor_and_adjusted_cost, :needs => [:emission_factor, :adjusted_cost] do |characteristics|
+              #       lbs CO2e / 2002 US $              2002 US $
+              characteristics[:emission_factor] * characteristic[:adjusted_cost]
+            end
+            
+            provides.quorum :default do
+              raise "The purchase's default emission quorum should never be called"
+            end
+          end
+          
+          committee :emission_factor do |provides|
+            # FIXME TODO this actually has to access the io model and return a whole array of data
+            provides.quorum :from_io_sector, :needs => [:io_sector] do |characteristics|
+              characteristics[:io_sector]
+            
+              provides.quorum :default do
+                # fallback emission_factor
+              end
+            end
+          end
+            
+          committee :io_sector do |provides|
+            provides.quorum :from_industry, :needs => [:industry] do |characteristics|
+              if characteristics[:industry].io_sector != #FIXME TODO the io sectors for wholesale and retail trade
+                characteristics[:industry].io_sector
+              else
+                characteristics[:industry].product_line.industry # FIXME TODO look up the industries that make the product lines that are made by the original industry
+              end
+            end
+          end
+            
+          committee :industry do |provides|
+            provides.quorum :from_merchant_category, :needs => [:merchant_category] do |characteristics|
+              characteristics[:merchant_category].industry
+            end
+          end
+            
+          committee :merchant_category do |provides|
+            provides.quorum :from_merchant, :needs => [:merchant] do |characteristics|
+              characteristics[:merchant].merchant_category
+            end
+          end
+            
+          committee :adjusted_cost do |provides|
+            # for now assuming is always US $ - later may need to figure out currency
+            provides.quorum :from_cost_and_date, :needs => [:cost, :date] do |characteristics|
+              # convert to 2002 US $ based on date and cost
+            end
+            
+            provides.quorum :from_purchase_amount_and_date, :needs => [:purchase_amount, :date] do |characteristics|
+              # adjust for tax and then convert to 2002 US $ based on date and cost
+            end
+          end
+        end
+        # FIXME TODO make other committees to report emissions by gas, by io sector, etc.
+      end
+    end
+  end
+end

data/lib/purchase/characterization.rb

@@ -0,0 +1,26 @@
+require 'characterizable'
+
+module BrighterPlanet
+  module Purchase
+    module Characterization
+      def self.included(base)
+        base.send :include, Characterizable
+        base.characterize do
+          has :merchant do |merchant|
+            merchant.reveals :merchant_category
+          end
+          has :industry
+          has :product_line
+          has :io_sector
+          has :purchase_amount # full purchase amount
+          has :tax             # tax portion of purchase
+          has :cost            # cost before tax
+          has :line_item
+          has :customer_code
+          has :zip_code
+          has :date
+        end
+      end
+    end
+  end
+end

data/lib/purchase/data.rb

@@ -0,0 +1,34 @@
+require 'data_miner'
+
+module BrighterPlanet
+  module Purchase
+    module Data
+      def self.included(base)
+        base.data_miner do
+          schema do
+            integer 'merchant_id'
+            string  'mcc'
+            string  'naics_code' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+            string  'pscode' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+            string  'io_code' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+            float   'purchase_amount'
+            float   'tax'
+            float   'cost'
+            string  'line_item'
+            string  'customer_code'
+            string  'zip_code_name'
+            date    'date'
+            float   'adjusted_cost'
+            string  'adjusted_cost_units'
+            float   'emission_factor'
+            string  'emission_factor_units'
+          end
+          
+          process "Pull dependencies" do
+            run_data_miner_on_belongs_to_associations
+          end
+        end
+      end
+    end
+  end
+end

data/lib/purchase/summarization.rb

@@ -0,0 +1,22 @@
+require 'summary_judgement'
+
+module BrighterPlanet
+  module Purchase
+    module Summarization
+      def self.included(base)
+        base.extend SummaryJudgement
+        base.summarize do |has|
+          has.identity 'purchase'
+
+          has.verb :take
+          has.aspect :perfect
+
+          has.modifier lambda { |purchase| "from #{flight.merchant}" }, :if => :merchant
+          has.modifier lambda { |purchase| "(#{purchase.inudstry} industry)" }, :if => :industry
+          has.modifier lambda { |purchase| "for $#{purchase.purchase_amount}" }, :if => :purchase_amount
+          has.modifier lambda { |purchase| "on #{date.to_formatted_s(:archive)}" }, :if => :date
+        end
+      end
+    end
+  end
+end

data/lib/purchase.rb

@@ -0,0 +1,33 @@
+module BrighterPlanet
+  module Purchase
+    attr_accessor :merchant_category_code
+
+    module ClassMethods
+      def included(base)
+        require 'cohort_scope'
+        require 'falls_back_on'
+        require 'falls_back_on/active_record_ext'
+
+        require 'purchase/carbon_model'
+        require 'purchase/characterization'
+        require 'purchase/data'
+        require 'purchase/summarization'
+
+        base.send :include, BrighterPlanet::Purchase::CarbonModel
+        base.send :include, BrighterPlanet::Purchase::Characterization
+        base.send :include, BrighterPlanet::Purchase::Data
+        base.send :include, BrighterPlanet::Purchase::Summarization
+      end
+      def flight_model
+        if Object.const_defined? 'Purchase'
+          ::Purchase
+        elsif Object.const_defined? 'PurchaseRecord'
+          PurchaseRecord
+        else
+          raise 'There is no purchase model'
+        end
+      end
+    end
+    extend ClassMethods
+  end
+end

data/lib/test_support/db/schema.rb

@@ -0,0 +1,22 @@
+require 'sniff/database'
+
+Sniff::Database.define_schema do
+  create_table "purchase_records", :force => true do |t|
+    t.integer 'merchant_id'
+    t.string  'mcc'
+    t.string  'naics_code' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+    t.string  'pscode' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+    t.string  'io_code' # FIXME TODO not sure how to deal with the fact that a single purchase may have multiple industries, product lines, and io sectors
+    t.float   'purchase_amount'
+    t.float   'tax'
+    t.float   'cost'
+    t.string  'line_item'
+    t.string  'customer_code'
+    t.string  'zip_code_name'
+    t.date    'date'
+    t.float   'adjusted_cost'
+    t.string  'adjusted_cost_units'
+    t.float   'emission_factor'
+    t.string  'emission_factor_units'
+  end
+end

data/lib/test_support/purchase_record.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'falls_back_on'
+require 'purchase'
+require 'sniff'
+
+class PurchaseRecord < ActiveRecord::Base
+  include Sniff::Emitter
+  include BrighterPlanet::Purchase
+end

metadata

@@ -0,0 +1,343 @@
+--- !ruby/object:Gem::Specification 
+name: purchase
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andy Rossmeissl
+- Seamus Abshere
+- Ian Hough
+- Matt Kling
+- Derek Kastner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1848230024
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196359
+        segments: 
+        - 1
+        - 0
+        - 0
+        - beta
+        - 2
+        version: 1.0.0.beta.2
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: cucumber
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 8
+        - 3
+        version: 0.8.3
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rdoc
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196417
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 17
+        version: 2.0.0.beta.17
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sniff
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 0
+        - 10
+        version: 0.0.10
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: characterizable
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 0
+        - 12
+        version: 0.0.12
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: data_miner
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: earth
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 0
+        - 7
+        version: 0.0.7
+  requirement: *id011
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: falls_back_on
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  requirement: *id012
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: fast_timestamp
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  requirement: *id013
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: leap
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  requirement: *id014
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: summary_judgement
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 3
+        - 8
+        version: 1.3.8
+  requirement: *id015
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: timeframe
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 0
+        - 8
+        version: 0.0.8
+  requirement: *id016
+description: A software model in Ruby for the greenhouse gas emissions of a purchase
+email: seamus@brighterplanet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- lib/purchase.rb
+- lib/purchase/carbon_model.rb
+- lib/purchase/characterization.rb
+- lib/purchase/data.rb
+- lib/purchase/summarization.rb
+- lib/test_support/db/schema.rb
+- lib/test_support/purchase_record.rb
+- features/support/env.rb
+- features/purchase_committees.feature
+- features/purchase_emissions.feature
+has_rdoc: true
+homepage: http://github.com/brighterplanet/purchase
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A carbon model
+test_files: 
+- features/support/env.rb
+- features/purchase_committees.feature
+- features/purchase_emissions.feature
+- lib/test_support/db/schema.rb
+- lib/test_support/purchase_record.rb