alpha_card 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706d4fb925ed92b75aeb824e9ac0cb1353b4cd5e
-  data.tar.gz: ddd2530759a1516a3008c10635105acdb19d7782
+  metadata.gz: 9578c7b0b9b2681146ac0370640b26ed9b6d7cd4
+  data.tar.gz: a9ade4a67954c16fc8c3bff0dd8b92838b820358
 SHA512:
-  metadata.gz: 35b50540e1457d8f9774307dcb7443d084c24ede72a009dca98430a265bb5a0dea4162b3fe9f7785a66c62dbdb2094c280a6fb164d08afd6d628515c30bca624
-  data.tar.gz: ee1eb394decc0933f881f4f8e9931ae083cb215b4d1a0d622d15befa0d361cbdbfefb1cdd7d3bdd63e8651317c428c11ed11ec9d733e9bff4e7910f61ecb967a
+  metadata.gz: d9e4b44f63a547a82f1c4a4fd405790436fa663bb31aabe3ba22c995cccc5b7333b0c6f25c4bdc2802209e29c03141899d8bd1df5ed9fa95917c769eb6663a42
+  data.tar.gz: bff105616d044b9560ed7f53dc2b47702134b2aa4d3fc86f2a7939abadccebea6bcd9569b8210151f4456f817c6ffb7520c796c970fb8ddc301f5ab13cae47c5

data/README.md

@@ -212,14 +212,16 @@ You are very welcome to help improve alpha_card if you have suggestions for feat
 
 To contribute:
 
-1. Fork the project
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Make your changes
-4. Add tests
-5. Run `rake` to make sure all tests pass
-6. Commit your changes (`git commit -am 'Add new feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create new pull request
+1. Fork the project.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add tests for your feature or bug fix.
+7. Run `rake` to make sure all tests pass.
+8. Commit your changes (`git commit -am 'Add new feature'`).
+9. Push to the branch (`git push origin my-new-feature`).
+10. Create new pull request.
 
 Thanks.
 

data/alpha_card.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |gem|
   gem.name = 'alpha_card'
-  gem.version = '0.1.8'
-  gem.date = '2014-07-01'
+  gem.version = '0.1.9'
+  gem.date = '2014-07-02'
   gem.summary = 'Alpha Card Services DirectPost API for Ruby'
   gem.description = 'Gem for creating sales with Alpha Card Services DirectPost API'
   gem.authors = ['Nikita Bulaj']

data/lib/alpha_card.rb

@@ -25,7 +25,7 @@ module AlphaCard
   # Global Payment Systems (NDC) Credit Card Authorization Codes
   #
   # @see http://floristwiki.ftdi.com/images/c/ce/Appendix_A_-_Credit_Card_Authorization_Codes.pdf Credit Card Authorization Codes
-  CREDIT_CARD_CODES = YAML.load_file(File.expand_path('../alpha_card/data/codes.yml', __FILE__)) unless defined? CREDIT_CARD_CODES
+  CREDIT_CARD_CODES ||= YAML.load_file(File.expand_path('../alpha_card/data/codes.yml', __FILE__))
 
   class << self
 	# @return [String] Alpha Card Gateway DirectPost API URL.
@@ -35,7 +35,7 @@ module AlphaCard
   ##
   # Send the POST request to the AlphaCard Gateway from the
   # specified account. Request must contains params - Alpha Card
-  # transcation variables.
+  # transaction variables.
   #
   # @param [Hash] params
   #   Alpha Card transaction variables.

data/lib/alpha_card/alpha_card_response.rb

@@ -4,6 +4,8 @@ module AlphaCard
   # Contains all the data, that Alpha Card Gateway
   # returned for the request.
   class AlphaCardResponse
+    # Alpha Card Gateway response as a <code>Hash</code>.
+    # @attr_reader [Hash] data
     attr_reader :data
 
     # Success response code
@@ -13,30 +15,115 @@ module AlphaCard
     # Error response code
     ERROR    = '3'
 
-    def initialize(request_body)
-      @data = AlphaCard::Utils.parse_query(request_body)
+    ##
+    # AlphaCardResponse constructor.
+    #
+    # @param [String] response_body
+    #   Alpha Card Gateway response body text
+    #
+    # @return [AlphaCardResponse] AlphaCardResponse object
+    #
+    # @example
+    #   AlphaCard::AlphaCardResponse.new('response=1&responsetext=Test')
+    #
+    #   #=> #<AlphaCard::AlphaCardResponse:0x00000003f2b568 @data={"response"=>"1", "responsetext"=>"Test"}>
+    def initialize(response_body)
+      @data = AlphaCard::Utils.parse_query(response_body)
     end
 
+    ##
+    # The text of the Alpha Card Gateway response.
+    #
+    # @return [String] text of the response
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=1&responsetext=Test")
+    #   r.text
+    #
+    #   #=> 'Test'
     def text
       @data['responsetext']
     end
 
+    ##
+    # The ID of the transaction. Can be used to process
+    # refund operation.
+    #
+    # @return [String] transaction ID
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=1&transactionid=123")
+    #   r.transaction_id
+    #
+    #   #=> '123'
     def transaction_id
       @data['transactionid']
     end
 
+    ##
+    # The code of the Alpha Card Gateway response.
+    #
+    # @return [String] code of the response
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=1&response_code=100")
+    #   r.code
+    #
+    #   #=> '100'
     def code
       @data['response_code']
     end
 
+    ##
+    # Indicate the state of the request to the
+    # Alpha Card Gateway. Returns <i>true</i> if
+    # response was <i>approved</i>.
+    #
+    # @return [Bool] true if request if successful
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=1")
+    #   r.success?
+    #
+    #   #=> true
     def success?
       @data['response'] == APPROVED
     end
 
+    ##
+    # Indicate the state of the request to the
+    # Alpha Card Gateway. Returns <i>true</i> if
+    # response was <i>declined</i>.
+    #
+    # @return [Bool] true if request was declined
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=2")
+    #   r.declined?
+    #
+    #   #=> true
     def declined?
       @data['response'] == DECLINED
     end
 
+    ##
+    # Indicate the state of the request to the
+    # Alpha Card Gateway. Returns <i>true</i> if
+    # response has some <i>errors</i>.
+    #
+    # @return [Bool] true if request has some errors
+    #
+    # @example
+    #
+    #   r = AlphaCardResponse.new("response=3")
+    #   r.error?
+    #
+    #   #=> true
     def error?
       @data['response'] == ERROR
     end

data/lib/alpha_card/utils.rb

@@ -11,67 +11,55 @@ module AlphaCard
       # Default separators for the query string.
       DEFAULT_SEP = /[&;] */n
 
-      # A part of the rack gem.
-      class KeySpaceConstrainedParams
-        def initialize(limit = 65536)
-          @limit = limit
-          @size = 0
-          @params = {}
-        end
-
-        def [](key)
-          @params[key]
-        end
-
-        def []=(key, value)
-          @size += key.size if key && !@params.key?(key)
-          raise RangeError, 'exceeded available parameter key space' if @size > @limit
-          @params[key] = value
-        end
-
-        ##
-        # Returns <code>true</code> if the given key is present
-        # in <i>params</i>.
-        def key?(key)
-          @params.key?(key)
-        end
-
-        ##
-        # Converts params to <code>Hash</code> object.
-        def to_params_hash
-          hash = @params
-          hash.keys.each do |key|
-            value = hash[key]
-            if value.kind_of?(self.class)
-              hash[key] = value.to_params_hash
-            elsif value.kind_of?(Array)
-              value.map! { |x| x.kind_of?(self.class) ? x.to_params_hash : x }
-            end
-          end
-          hash
-        end
-      end
-
       ##
       # Unescapes a URI escaped string with +encoding+. +encoding+ will be the
       # target encoding of the string returned, and it defaults to UTF-8
-      if defined?(::Encoding)
-        def unescape(s, encoding = Encoding::UTF_8)
-          URI.decode_www_form_component(s, encoding)
-        end
-      else
-        def unescape(s, encoding = nil)
-          URI.decode_www_form_component(s, encoding)
-        end
+      #
+      # @param [String] s
+      #   String to unescape.
+      #
+      # @param [Encoding] encoding
+      #   Type of <code>Encoding</code>.
+      #
+      # @return [String] URI encoded string
+      #
+      # @raise [ArgumentError] if invalid Encoding is passed
+      #
+      # @example
+      #
+      #   unescape('Test%20str')
+      #   #=> "Test str"
+      #
+      #   unescape('Test%20str', Encoding::WINDOWS_31J)
+      #   #=> "Test str"
+      def unescape(s, encoding = Encoding::UTF_8)
+        URI.decode_www_form_component(s, encoding)
       end
 
       ##
-      # Parses a query string to a Hash by breaking it up
+      # Parse query string to a <code>Hash</code> by breaking it up
       # at the '&' and ';' characters.
+      #
+      # @param [String] qs
+      #   query string
+      # @param [String] d
+      #   delimiter for the params
+      # @yieldparam unescaper
+      #   method, that will unescape the param value
+      #
+      # @return [Hash] query
+      #
+      # @example
+      #
+      #   query = AlphaCard::Utils.parse_query("param1=value1&params2=")
+      #   #=> {"param1"=>"value1", "params2"=>""}
+      #
+      #   query = AlphaCard::Utils.parse_query("cars[]=Saab&cars[]=Audi")
+      #   #=> {"cars[]"=>["Saab", "Audi"]}
       def parse_query(qs, d = nil, &unescaper)
         unescaper ||= method(:unescape)
 
-        params = KeySpaceConstrainedParams.new
+        params = {}
 
         (qs || '').split(d ? /[#{d}] */n : DEFAULT_SEP).each do |p|
           next if p.empty?
@@ -88,7 +76,7 @@ module AlphaCard
           end
         end
 
-        params.to_params_hash
+        params
       end
     end
   end

data/spec/alpha_card/alpha_card_account_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe AlphaCard::Account do
+  let!(:valid_account) { AlphaCard::Account.new('demo', 'password') }
+  let!(:invalid_account) { AlphaCard::Account.new('', '') }
+
+  context 'with valid credentials' do
+    it 'should return true if credentials are filled' do
+      expect(valid_account.filled?).to be_truthy
+    end
+  end
+
+  context 'with invalid credentials' do
+    it 'should return false if credentials are filled' do
+      expect(invalid_account.filled?).to be_falsey
+    end
+  end
+end

data/spec/alpha_card/alpha_card_utils_spec.rb

@@ -0,0 +1,25 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe AlphaCard::Utils do
+  it 'parse query strings correctly' do
+    expect(AlphaCard::Utils.parse_query("foo=bar")).to eq("foo" => "bar")
+    expect(AlphaCard::Utils.parse_query('cars[]=Saab&cars[]=Audi')).to eq({'cars[]' => ['Saab', 'Audi']})
+    expect(AlphaCard::Utils.parse_query("foo=bar&foo=quux")).to eq("foo" => ["bar", "quux"])
+    expect(AlphaCard::Utils.parse_query("foo=1&bar=2")).to eq("foo" => "1", "bar" => "2")
+    expect(AlphaCard::Utils.parse_query("my+weird+field=q1%212%22%27w%245%267%2Fz8%29%3F")).to eq("my weird field" => "q1!2\"'w$5&7/z8)?")
+    expect(AlphaCard::Utils.parse_query("foo%3Dbaz=bar")).to eq("foo=baz" => "bar")
+    expect(AlphaCard::Utils.parse_query("=")).to eq("" => "")
+    expect(AlphaCard::Utils.parse_query("=value")).to eq("" => "value")
+    expect(AlphaCard::Utils.parse_query("key=")).to eq("key" => "")
+    expect(AlphaCard::Utils.parse_query("&key&")).to eq("key" => nil)
+  end
+
+  it 'unescape the characters correctly' do
+    expect(AlphaCard::Utils.unescape('%E9%9F%93', Encoding::UTF_8)).to eq('韓')
+    expect(AlphaCard::Utils.unescape("fo%3Co%3Ebar")).to eq("fo<o>bar")
+    expect(AlphaCard::Utils.unescape("a+space")).to eq("a space")
+    expect(AlphaCard::Utils.unescape("a%20space")).to eq("a space")
+    expect(AlphaCard::Utils.unescape("q1%212%22%27w%245%267%2Fz8%29%3F%5C")).to eq("q1!2\"'w$5&7/z8)?\\")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alpha_card
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Nikita Bulaj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -49,8 +49,10 @@ files:
 - lib/alpha_card/sale.rb
 - lib/alpha_card/shipping.rb
 - lib/alpha_card/utils.rb
+- spec/alpha_card/alpha_card_account_spec.rb
 - spec/alpha_card/alpha_card_response_spec.rb
 - spec/alpha_card/alpha_card_spec.rb
+- spec/alpha_card/alpha_card_utils_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/budev/alpha_card
 licenses: