mswallet 0.0.1

data/lib/mswallet.rb

@@ -0,0 +1,14 @@
+require 'mswallet/version'
+require 'rack/mswallet_rack'
+
+module Mswallet
+  autoload :Pass, 'mswallet/pass'
+
+  class << self
+    attr_accessor :custom_rack_handler
+    def configure
+      yield self
+    end
+  end
+
+end

data/lib/mswallet/pass.rb

@@ -0,0 +1,187 @@
+require 'xml/libxml'
+require 'zip'
+
+module Mswallet
+  class Pass
+    TYPES = %W(Deal General PaymentInstrument Ticket BoardingPass MembershipCard )
+
+    attr_accessor :pass, :files, :locales
+
+    def initialize(pass = nil)
+      @pass = pass || self.class.init
+      @locales = {}
+      @files = []
+      yield(self) if block_given?
+    end
+
+    def []=(key, val)
+      result = convert_to_xml(key, val)
+      if result.is_a? Array
+        result.each { |item| @pass.root << item }
+      else
+        @pass.root << result
+      end
+    end
+
+    def [](key)
+      @pass.root.find(key).first
+    end
+
+    def add_file(file)
+      @files << file
+    end
+
+    def add_locale(lang, file)
+      @locales[lang] = file
+    end
+
+    # Return a Tempfile containing our ZipStream
+    def file(options = {})
+      options[:file_name] ||= 'pass.mswallet'
+      temp_file = Tempfile.new(options[:file_name])
+      temp_file.write self.stream.string
+      temp_file.close
+      temp_file
+    end
+    # Return a ZipOutputStream
+    def stream
+      check_pass
+      output_zip
+    end
+
+    def self.init
+      doc = XML::Document.new
+      doc.encoding = XML::Encoding::UTF_8
+      root = XML::Node.new 'WalletItem'
+      doc.root = root
+
+      version_el = XML::Node.new('Version')
+      version_el.content = WALLET_VERSION
+      root << version_el
+
+      return doc
+    end
+
+    def valid?
+      check_pass
+      true
+    rescue
+      false
+    end
+
+    private
+
+    def convert_to_xml(key, val)
+      case val
+        when Hash
+          el = XML::Node.new(key)
+          val.each do |k,v|
+            res = convert_to_xml(k, v)
+            if res.is_a? Array
+              res.each {|item| el << item }
+            else
+              el << res
+            end
+          end
+        when Array
+          el = []
+          val.each do |v|
+            el << convert_to_xml(key, v)
+          end
+        else
+          el = XML::Node.new(key)
+          if val
+            el.content = val.to_s
+          else
+            text_node = XML::Node.new_text('&#160;')
+            text_node.output_escaping = false
+            el << text_node
+          end
+
+      end
+      el
+    end
+
+    def check_pass
+# Check for default images
+      [99, 159, 336].each do |size|
+        raise "Logo#{size}x#{size} missing" unless @files.detect {|f| f[:name] == "Logo#{size}x#{size}.png" }
+      end
+
+# Check for developer field in XML
+
+      fail 'Pass must be XML::Document object' unless @pass.is_a? XML::Document
+
+      root = @pass.find('WalletItem')
+
+      fail 'WalletItem node missing' unless root
+
+      {
+          'Version' => ['Format Version missing', Mswallet::WALLET_VERSION ],
+          'Kind' => ['Pass Kind Identifier missing', TYPES ],
+          'Id' => ['Id missing'],
+          'DisplayName' => ['Display Name missing' ],
+          'IssuerDisplayName' => ['Issuer Display Name missing'],
+          'HeaderColor' => ['Header Color missing', /^#(?:[\da-fA-F]{2}){3}$/],
+          'BodyColor' => ['Body Name missing', /#(?:[\d\w]){3}/]
+
+      }.each do |tag, params|
+        msg, value = params
+        el = @pass.find(tag).first
+        fail msg unless el
+
+        case value
+          when Array
+            fail "#{tag} not in #{value.join(',')}" unless value.include?(el.content) unless value.empty?
+          when Regexp
+            fail "#{tag} not match #{value.to_s}" unless el.content.match value
+          when nil
+            nil
+          else
+            fail "#{tag} must be #{value}" unless value == el.content
+        end
+      end
+
+    end
+
+    def output_zip
+      buffer = Zip::OutputStream.write_buffer do |zip|
+        zip.put_next_entry 'WalletItem.xml'
+        zip.write @pass.to_s
+
+        @files.each do |file|
+          if file.class == Hash
+            zip.put_next_entry file[:name]
+            zip.print file[:content]
+          else
+            zip.put_next_entry File.basename(file)
+            zip.print IO.read(file)
+          end
+        end
+
+        @locales.each do |lang, file|
+          zip.put_next_entry "#{lang}/strings.txt"
+
+          data = ''
+          case file
+            when String
+              data = file
+            when File
+              data = file.read
+            when Hash
+              file.each do |k, v|
+                data += "#{k}=#{v}\n"
+              end
+            else
+              fail 'wrong locale object'
+          end
+
+          zip.print data
+        end
+      end
+      
+      buffer
+    end
+
+  end
+end

data/lib/mswallet/version.rb

@@ -0,0 +1,5 @@
+module Mswallet
+  VERSION = "0.0.1"
+  WALLET_VERSION = '1'
+  RACK_API_VERSION = 'v1'
+end

data/lib/rack/mswallet_rack.rb

@@ -0,0 +1,52 @@
+module Rack
+  class MswalletRack
+
+    def initialize(app)
+      @app = app
+      @parameters = {}
+    end
+
+    def call(env)
+      @parameters['authToken'] = env['HTTP_AUTHENTICATIONTOKEN'] if env['HTTP_AUTHENTICATIONTOKEN']
+      @parameters.merge!(Rack::Utils.parse_nested_query(env['QUERY_STRING']))
+      @parameters['path'] = env['PATH_INFO']
+      serial_number = find_id @parameters['path']
+      @parameters['serialNumber'] = serial_number
+      if serial_number
+        handler = Mswallet.custom_rack_handler || Mswallet::Handler
+        response = handler.update(@parameters)
+        header = {'Content-Type' => 'application/vnd.ms.wallet',
+                  'Content-Disposition' => 'attachment',
+                  'filename' => "#{serial_number}.mswallet"}
+        case response
+          when Mswallet::Pass
+            [200, header, [response.stream.string]]
+          when String
+            [200, header, [response]]
+          when File, StringIO, Zip::OutputStream, Tempfile
+            [200, header, [response.read]]
+          when false
+            [304, {}, {}]
+          else
+            [401, {}, {}]
+        end
+
+      else
+        @app.call env
+      end
+    end
+
+    def append_parameter_separator url
+    end
+
+    def each(&block)
+    end
+
+    def find_id(path)
+      return nil unless path =~ /\/#{Mswallet::RACK_API_VERSION}\/walletitems\/([\d\w]+)/
+      $1
+    end
+
+  end
+end
+

data/mswallet.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mswallet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mswallet'
+  spec.version       = Mswallet::VERSION
+  spec.authors       = ['ajieks@vmp.ru']
+  spec.email         = %w(ajieks@vmp.ru schalexe@gmail.com)
+  spec.summary       = %q{A Windows Phone wallet pass generator.}
+  spec.description   = %q{This gem allows you to create passes for Windows Phone Wallet. Unlike some, this works with Rails but does not require it.}
+  spec.homepage      = 'http://github.com/fuCtor/mswallet'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test', ['>= 0']
+  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'libxml-ruby'
+  spec.add_dependency 'rack'
+  spec.add_dependency('rubyzip', [">= 1.0.0"])
+
+end

data/spec/mswallet/mswallet_spec.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+describe Mswallet do
+
+  it 'should be wallet version eq 1' do
+    expect(Mswallet::WALLET_VERSION).to be_eql('1')
+  end
+end

data/spec/mswallet/pass_spec.rb

@@ -0,0 +1,190 @@
+require 'rspec'
+
+describe Mswallet::Pass do
+
+  let :fields do
+    {
+        'Version' => ['Format Version missing', '1' ],
+        'Kind' => ['Pass Kind Identifier missing', 'General' ],
+        'Id' => ['Id missing', '1'],
+        'DisplayName' => ['Display Name missing' ],
+        'IssuerDisplayName' => ['Issuer Display Name missing'],
+        'HeaderColor' => ['Header Color missing', %W(#000000 #AABBCC)],
+        'BodyColor' => ['Body Name missing', %W(#000000 #AABBCC)]
+    }
+  end
+
+  let :wallet do
+    w = Mswallet::Pass.init
+    fields.each  do |*args|
+      tag, msg, *value = args.flatten.map(&:to_s)
+      el = XML::Node.new(tag)
+      w.root << el
+
+      case value
+        when Array
+          el.content = value.first.to_s
+        when nil
+
+        else
+          el.content = value
+      end
+    end
+    w
+  end
+  let :pass do Mswallet::Pass.new wallet end
+
+  it '#init' do
+    expect { wallet } .to_not raise_error
+    expect( wallet ).to be_instance_of(XML::Document)
+    expect( wallet.root.name ).to be_eql 'WalletItem'
+    expect( wallet.root.find('Version').empty? ).to be_falsey
+    expect( wallet.root.find('Version').first.content ).to be_eql(Mswallet::WALLET_VERSION)
+  end
+
+  it '#add_file' do
+    expect { pass } .to_not raise_error
+    expect( pass.files ).to be_empty
+    expect { pass.add_file name: 'Logo336x336.png', content: ''  } .to_not raise_error
+    expect( pass.files ).to_not be_empty
+  end
+
+  context 'locale' do
+    it '#add_locale' do
+
+      expect { pass } .to_not raise_error
+      expect( pass.locales ).to be_empty
+      expect { pass.add_locale 'ru-RU', ''  } .to_not raise_error
+      expect { pass.add_locale 'ru-RU', {}  } .to_not raise_error
+      expect { pass.add_locale 'ru-RU', File.new(__FILE__, 'r')  } .to_not raise_error
+      expect { pass.add_locale 'ru-RU', true  } .to_not raise_error
+
+      expect( pass.locales ).to_not be_empty
+      expect( pass.locales['ru-RU'] ).to be_truthy
+    end
+
+    context 'serialize' do
+      before do
+        [99, 159, 336].each do |size|
+          pass.add_file name: "Logo#{size}x#{size}.png", content: ''
+        end
+
+        pass.add_locale 'ru-RU', locale
+      end
+
+      context 'from string' do
+        let(:locale) { '' }
+        it do
+          expect { pass.stream } .to_not raise_error
+        end
+      end
+
+      context 'from file' do
+        let(:locale) { File.new(__FILE__, 'r') }
+        it do
+          expect { pass.stream } .to_not raise_error
+        end
+      end
+
+      context 'from hash' do
+        let(:locale) { {} }
+        it do
+          expect { pass.stream } .to_not raise_error
+        end
+      end
+
+      context 'from other' do
+        let(:locale) { nil }
+        it do
+          expect { pass.stream } .to raise_error 'wrong locale object'
+        end
+      end
+    end
+  end
+
+
+  it '#pass_check' do
+    expect { pass } .to_not raise_error
+
+    [99, 159, 336].each do |size|
+      expect( pass.valid? ) .to be_falsey
+      expect { pass.stream } .to raise_error /Logo#{size}x#{size}/
+      expect { pass.add_file name: "Logo#{size}x#{size}.png", content: ''  } .to_not raise_error
+    end
+
+    fields.keys.reverse  do |tag|
+      msg, *value = fields[tag].map(&:to_s)
+      expect { pass.stream } .to_not raise_error msg
+
+      el = wallet.root.find(tag).first
+
+      if value
+        el.content = ''
+        expect { pass.stream } .to raise_error /#{tag}/
+      end
+
+      el.remove!
+      expect { pass.stream } .to raise_error msg
+    end
+    expect( pass.valid? ) .to be_truthy
+  end
+
+
+  context '#[]=' do
+    let(:key) {'key'}
+    after do
+      expect(wallet.root.find(key).first).to be_nil
+
+      expect{ pass[key] = value }.to_not raise_error
+
+      expect(wallet.root.find(key).first).to_not be_nil
+      expect(pass[key]).to be_instance_of XML::Node
+    end
+
+    context 'string value' do
+      let(:value) { 'content' }
+      it do; end
+    end
+
+    context 'hash value' do
+      let(:value) { { 'key2' => 'content', key3: 'content'} }
+      it do; end
+    end
+
+    context 'string array value' do
+      let(:value) { %w(a b c) }
+      it do; end
+    end
+
+    context 'hash array value' do
+      let(:value) { [{a: 1},{b: 2}] }
+      it do; end
+    end
+
+    context 'nil value' do
+      let(:value) { nil }
+      it do; end
+    end
+
+  end
+
+  context 'valid pass' do
+    before do
+      [99, 159, 336].each do |size|
+        pass.add_file name: "Logo#{size}x#{size}.png", content: ''
+      end
+
+      pass.add_locale 'ru-RU', ''
+    end
+
+    it '#stream' do
+      expect { pass.stream } .to_not raise_error
+      expect( pass.stream.string.empty? ) .to be_falsey
+    end
+
+    it '#file' do
+      expect { pass.file } .to_not raise_error
+    end
+  end
+
+end