paypkg 0.1.0 → 0.1.1

data/lib/paypkg/paypal-countries.rb

@@ -0,0 +1,233 @@
+#####################
+### COUNTRY CODES ###
+#####################
+
+module PaypalCountries
+  PAYPAL_COUNTRIES = {
+    "ALAND ISLANDS" => "AX",
+    "ALBANIA" => "AL",
+    "ALGERIA" => "DZ",
+    "AMERICAN SAMOA" => "AS",
+    "ANDORRA" => "AD",
+    "ANGOLA" => "AO",
+    "ANGUILLA" => "AI",
+    "ANTARCTICA" => "AQ",
+    "ANTIGUA AND BARBUDA" => "AG",
+    "ARGENTINA" => "AR",
+    "ARMENIA" => "AM",
+    "ARUBA" => "AW",
+    "AUSTRALIA" => "AU",
+    "AUSTRIA" => "AT",
+    "AZERBAIJAN" => "AZ",
+    "BAHAMAS" => "BS",
+    "BAHRAIN" => "BH",
+    "BANGLADESH" => "BD",
+    "BARBADOS" => "BB",
+    "BELGIUM" => "BE",
+    "BELIZE" => "BZ",
+    "BENIN" => "BJ",
+    "BERMUDA" => "BM",
+    "BHUTAN" => "BT",
+    "BOLIVIA" => "BO",
+    "BOSNIA-HERZEGOVINA" => "BA",
+    "BOTSWANA" => "BW",
+    "BOUVET ISLAND" => "BV",
+    "BRAZIL" => "BR",
+    "BRITISH INDIAN OCEAN TERRITORY" => "IO",
+    "BRUNEI DARUSSALAM" => "BN",
+    "BULGARIA" => "BG",
+    "BURKINA FASO" => "BF",
+    "BURUNDI" => "BI",
+    "CAMBODIA" => "KH",
+    "CANADA" => "CA",
+    "CAPE VERDE" => "CV",
+    "CAYMAN ISLANDS" => "KY",
+    "CENTRAL AFRICAN REPUBLIC" => "CF",
+    "CHAD" => "TD",
+    "CHILE" => "CL",
+    "CHINA" => "CN (For domestic Chinese bank transactions only)",
+    "CHRISTMAS ISLAND" => "CX",
+    "COCOS (KEELING) ISLANDS" => "CC",
+    "COLOMBIA" => "CO",
+    "COMOROS" => "KM",
+    "DEMOCRATIC REPUBLIC OF CONGO" => "CD",
+    "CONGO" => "CG",
+    "COOK ISLANDS" => "CK",
+    "COSTA RICA" => "CR",
+    "CROATIA" => "HR",
+    "CYPRUS" => "CY",
+    "CZECH REPUBLIC" => "CZ",
+    "DENMARK" => "DK",
+    "DJIBOUTI" => "DJ",
+    "DOMINICA" => "DM",
+    "DOMINICAN REPUBLIC" => "DO",
+    "ECUADOR" => "EC",
+    "EGYPT" => "EG",
+    "EL SALVADOR" => "SV",
+    "ERITERIA" => "ER",
+    "ESTONIA" => "EE",
+    "ETHIOPIA" => "ET",
+    "FALKLAND ISLANDS (MALVINAS)" => "FK",
+    "FAROE ISLANDS" => "FO",
+    "FIJI" => "FJ",
+    "FINLAND" => "FI",
+    "FRANCE" => "FR",
+    "FRENCH GUIANA" => "GF",
+    "FRENCH POLYNESIA" => "PF",
+    "FRENCH SOUTHERN TERRITORIES" => "TF",
+    "GABON" => "GA",
+    "GAMBIA" => "GM",
+    "GEORGIA" => "GE",
+    "GERMANY" => "DE",
+    "GHANA" => "GH",
+    "GIBRALTAR" => "GI",
+    "GREECE" => "GR",
+    "GREENLAND" => "GL",
+    "GRENADA" => "GD",
+    "GUADELOUPE" => "GP",
+    "GUAM" => "GU",
+    "GUATEMALA" => "GT",
+    "GUERNSEY" => "GG",
+    "GUINEA" => "GN",
+    "GUINEA BISSAU" => "GW",
+    "GUYANA" => "GY",
+    "HEARD ISLAND AND MCDONALD ISLANDS" => "HM",
+    "HOLY SEE (VATICAN CITY STATE)" => "VA",
+    "HONDURAS" => "HN",
+    "HONG KONG" => "HK",
+    "HUNGARY" => "HU",
+    "ICELAND" => "IS",
+    "INDIA" => "IN",
+    "INDONESIA" => "ID",
+    "IRELAND" => "IE",
+    "ISLE OF MAN" => "IM",
+    "ISRAEL" => "IL",
+    "ITALY" => "IT",
+    "JAMAICA" => "JM",
+    "JAPAN" => "JP",
+    "JERSEY" => "JE",
+    "JORDAN" => "JO",
+    "KAZAKHSTAN" => "KZ",
+    "KENYA" => "KE",
+    "KIRIBATI" => "KI",
+    "KOREA, REPUBLIC OF" => "KR",
+    "KUWAIT" => "KW",
+    "KYRGYZSTAN" => "KG",
+    "LAOS" => "LA",
+    "LATVIA" => "LV",
+    "LESOTHO" => "LS",
+    "LIECHTENSTEIN" => "LI",
+    "LITHUANIA" => "LT",
+    "LUXEMBOURG" => "LU",
+    "MACAO" => "MO",
+    "MACEDONIA" => "MK",
+    "MADAGASCAR" => "MG",
+    "MALAWI" => "MW",
+    "MALAYSIA" => "MY",
+    "MALDIVES" => "MV",
+    "MALI" => "ML",
+    "MALTA" => "MT",
+    "MARSHALL ISLANDS" => "MH",
+    "MARTINIQUE" => "MQ",
+    "MAURITANIA" => "MR",
+    "MAURITIUS" => "MU",
+    "MAYOTTE" => "YT",
+    "MEXICO" => "MX",
+    "MICRONESIA, FEDERATED STATES OF" => "FM",
+    "MOLDOVA, REPUBLIC OF" => "MD",
+    "MONACO" => "MC",
+    "MONGOLIA" => "MN",
+    "MONTENEGRO" => "ME",
+    "MONTSERRAT" => "MS",
+    "MOROCCO" => "MA",
+    "MOZAMBIQUE" => "MZ",
+    "NAMIBIA" => "NA",
+    "NAURU" => "NR",
+    "NEPAL" => "NP",
+    "NETHERLANDS" => "NL",
+    "NETHERLANDS ANTILLES" => "AN",
+    "NEW CALEDONIA" => "NC",
+    "NEW ZEALAND" => "NZ",
+    "NICARAGUA" => "NI",
+    "NIGER" => "NE",
+    "NIUE" => "NU",
+    "NORFOLK ISLAND" => "NF",
+    "NORTHERN MARIANA ISLANDS" => "MP",
+    "NORWAY" => "NO",
+    "OMAN" => "OM",
+    "PALAU" => "PW",
+    "PALESTINE" => "PS",
+    "PANAMA" => "PA",
+    "PARAGUAY" => "PY",
+    "PAPUA NEW GUINEA" => "PG",
+    "PERU" => "PE",
+    "PHILIPPINES" => "PH",
+    "PITCAIRN" => "PN",
+    "POLAND" => "PL",
+    "PORTUGAL" => "PT",
+    "PUERTO RICO" => "PR",
+    "QATAR" => "QA",
+    "REUNION" => "RE",
+    "ROMANIA" => "RO",
+    "REPUBLIC OF SERBIA" => "RS",
+    "RUSSIAN FEDERATION" => "RU",
+    "RWANDA" => "RW",
+    "SAINT HELENA" => "SH",
+    "SAINT KITTS AND NEVIS" => "KN",
+    "SAINT LUCIA" => "LC",
+    "SAINT PIERRE AND MIQUELON" => "PM",
+    "SAINT VINCENT AND THE GRENADINES" => "VC",
+    "SAMOA" => "WS",
+    "SAN MARINO" => "SM",
+    "SAO TOME AND PRINCIPE" => "ST",
+    "SAUDI ARABIA" => "SA",
+    "SENEGAL" => "SN",
+    "SEYCHELLES" => "SC",
+    "SIERRA LEONE" => "SL",
+    "SINGAPORE" => "SG",
+    "SLOVAKIA" => "SK",
+    "SLOVENIA" => "SI",
+    "SOLOMON ISLANDS" => "SB",
+    "SOMALIA" => "SO",
+    "SOUTH AFRICA" => "ZA",
+    "SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS" => "GS",
+    "SPAIN" => "ES",
+    "SRI LANKA" => "LK",
+    "SURINAME" => "SR",
+    "SVALBARD AND JAN MAYEN" => "SJ",
+    "SWAZILAND" => "SZ",
+    "SWEDEN" => "SE",
+    "SWITZERLAND" => "CH",
+    "TAIWAN, PROVINCE OF CHINA" => "TW",
+    "TAJIKISTAN" => "TJ",
+    "TANZANIA, UNITED REPUBLIC OF" => "TZ",
+    "THAILAND" => "TH",
+    "TIMOR-LESTE" => "TL",
+    "TOGO" => "TG",
+    "TOKELAU" => "TK",
+    "TONGA" => "TO",
+    "TRINIDAD AND TOBAGO" => "TT",
+    "TUNISIA" => "TN",
+    "TURKEY" => "TR",
+    "TURKMENISTAN" => "TM",
+    "TURKS AND CAICOS ISLANDS" => "TC",
+    "TUVALU" => "TV",
+    "UGANDA" => "UG",
+    "UKRAINE" => "UA",
+    "UNITED ARAB EMIRATES" => "AE",
+    "UNITED KINGDOM" => "GB",
+    "UNITED STATES" => "US",
+    "UNITED STATES MINOR OUTLYING ISLANDS" => "UM",
+    "URUGUAY" => "UY",
+    "UZBEKISTAN" => "UZ",
+    "VANUATU" => "VU",
+    "VENEZUELA" => "VE",
+    "VIETNAM" => "VN",
+    "VIRGIN ISLANDS, BRITISH" => "VG",
+    "VIRGIN ISLANDS, U.S." => "VI",
+    "WALLIS AND FUTUNA" => "WF",
+    "WESTERN SAHARA" => "EH",
+    "YEMEN" => "YE",
+    "ZAMBIA" => "ZM"
+  }
+end

data/lib/paypkg/paypal-currencies.rb

@@ -0,0 +1,32 @@
+######################
+### CURRENCY CODES ###
+######################
+
+module PaypalCurrencies
+  PAYPAL_CURRENCIES = {
+    "Australian dollar" => "AUD",
+    "Brazilian real" => "BRL",
+    "Canadian dollar" => "CAD",
+    "Czech koruna" => "CZK",
+    "Danish krone" => "DKK",
+    "Euro" => "EUR",
+    "Hong Kong dollar" => "HKD",
+    "Hungarian forint" => "HUF",
+    "Israeli new shekel" => "ILS",
+    "Japanese yen" => "JPY",
+    "Malaysian ringgit" => "MYR",
+    "Mexican peso" => "MXN",
+    "New Taiwan dollar" => "TWD",
+    "New Zealand dollar" => "NZD",
+    "Norwegian krone" => "NOK",
+    "Philippine peso" => "PHP",
+    "Polish złoty" => "PLN",
+    "Pound sterling" => "GBP",
+    "Singapore dollar" => "SGD",
+    "Swedish krona" => "SEK",
+    "Swiss franc" => "CHF",
+    "Thai baht" => "THB",
+    "Turkish lira" => "TRY",
+    "United States dollar" => "USD"
+   }
+end

data/lib/paypkg/paypal-languages.rb

@@ -0,0 +1,35 @@
+######################
+### LANGUAGE CODES ###
+######################
+
+module PaypalLanguages
+  PAYPAL_LANGUAGES = [
+    "da_DK",
+    "de_DE",
+    "en_AU",
+    "en_GB",
+    "en_US",
+    "es_ES",
+    "es_XC",
+    "fr_CA",
+    "fr_FR",
+    "fr_XC",
+    "he_IL",
+    "id_ID",
+    "it_IT",
+    "ja_JP",
+    "nl_NL",
+    "no_NO",
+    "pl_PL",
+    "pt_BR",
+    "pt_PT",
+    "ru_RU",
+    "sv_SE",
+    "th_TH",
+    "tr_TR",
+    "zh_CN",
+    "zh_HK",
+    "zh_TW",
+    "zh_XC"
+  ]
+end

data/lib/paypkg/refund-sale.rb

@@ -0,0 +1,26 @@
+###############################################
+### Full or Partial Refund Previous Payment ###
+###############################################
+
+class Paypkg
+  # You can request a partial or full refund of a previous sale.
+  # You CANNOT, however, refund more than the original sale.
+  # If you need to do that, you'll have to do it manually
+  # through your PalPal account.
+  #
+  # If you think you'll ever want to look up the refund,
+  # you'll have to save the refund_id in your database.
+  #
+  # @param sale_id [String] Required.
+  # @param amount [Numeric] Required.
+  def refund_sale(sale_id, amount)
+    formatted_amount = "%0.2f"%amount
+    call_paypal("/v1/payments/sale/#{sale_id}/refund", "{
+      'amount': {
+        'total': #{formatted_amount},
+        'currency': 'USD'
+      }
+    }")
+    return (@status.last=='201') && (@hash.last[:state]=='completed')
+  end
+end

data/lib/paypkg/retrieve-credit-card.rb

@@ -0,0 +1,18 @@
+######################################
+### Retrieve a card from the vault ###
+######################################
+
+class Paypkg
+  # Retrieve a card from the vault.
+  # @param vault_id [String] The vault_id PayPal assigned when
+  #   you stored this card.
+  # @return [Hash] The card data, less the card number: only the
+  #   last 4 digits of the card number are returned. You can get
+  #   an error from this call if the card expired and PayPal
+  #   automatically removed it from the vault. If that happens,
+  #   you should delete it from your database.
+  def retrieve_credit_card(vault_id)
+    call_paypal("/v1/vault/credit-card/#{vault_id}")
+    return (@status.last=='200') && (@hash.last[:state]=='ok')
+  end
+end

data/lib/paypkg/retrieve-refund-transaction.rb

@@ -0,0 +1,14 @@
+###################################
+### Retrieve Refund Transaction ###
+###################################
+
+class Paypkg
+  # Use the refund_id to look up the refund.
+  # @param refund_id [String] Required.
+  # @return [json String] The same json string retured when
+  #   the refund was orginally completed.
+  def retrieve_refund_transaction(refund_id)
+    call_paypal("/v1/payments/refund/#{refund_id}")
+    return (@status.last=='200') && (['pending', 'completed', 'refunded', 'partially_refunded'].index(@hash.last[:state])>0)
+  end
+end

data/lib/paypkg/retrieve-sale-transaction.rb

@@ -0,0 +1,14 @@
+#################################
+### Retrieve Sale Transaction ###
+#################################
+
+class Paypkg
+  # Use the sale_id to look up the sale.
+  # @param sale_id [String] Required.
+  # @return [json String] The same json string retured when
+  #   the sale was orginally completed.
+  def retrieve_sale_transaction(sale_id)
+    call_paypal("/v1/payments/sale/#{sale_id}")
+    return (@status.last=='200') && (['pending', 'completed', 'refunded', 'partially_refunded'].index(@hash.last[:state])>0)
+  end
+end

data/lib/paypkg/store-credit-card.rb

@@ -0,0 +1,48 @@
+#########################
+### Store Credit Card ###
+#########################
+
+class Paypkg
+  # Store a credit card on the PalPal servers (in the vault, as the refer to it).
+  # A card so stored can be used later to make charges, as long as the expire
+  # date has not elapsed. Once the expire date elapses, eventually PayPal
+  # will automatically remove the card. The card vault_id will be returned
+  # from this call: you must save it in your database.
+  # @param type [String] Required.
+  # @param number [String] Required.
+  # @param expire_month [Numeric] Required.
+  # @param expire_year [Numeric] Required.
+  # @param cvv2 [String] Required.
+  # @param first_name [String] Required.
+  # @param last_name [String] Required.
+  # @param line1 [String] Required.
+  # @param line2 [String] Optional. To omit this parameter, use nil.
+  # @param city [String] Required.
+  # @param state [String] Required.
+  # @param postal_code [String] Required.
+  # @param country_code [String] Required.
+  # @return [String} The vault_id: you must save this in your database!
+  def store_credit_card(type, number, expire_month, expire_year, cvv2, first_name,
+    last_name, line1, line2, city, state, postal_code, country_code, payer_id)
+    json = "{
+      'payer_id':'#{payer_id}',
+      'type':'#{type}',
+      'number':'#{number}',
+      'expire_month':'#{expire_month}',
+      'expire_year':'#{expire_year}',
+      'cvv2':'#{cvv2}',
+      'first_name':'#{first_name}',
+      'last_name':'#{last_name}',
+      'billing_address':{
+        'line1':'#{line1}',\n"
+    json << " 'line2':'#{line2}',\n" if line2
+    json << " 'city':'#{city}',
+        'state':'#{state}',
+        'postal_code':'#{postal_code}',
+        'country_code':'#{country_code}'
+      }
+    }"
+    call_paypal("/v1/vault/credit-card", json)
+    return (@status.last=='201') && (@hash.last[:state]=='ok')
+  end
+end

data/lib/paypkg/validate-credit-card.rb

@@ -0,0 +1,71 @@
+############################
+### Validate Credit Card ###
+############################
+
+class Paypkg
+  # Validate a credit card by charging $0.01, then voiding the authorization.
+  # The reason for doing this is to validate that an actual charge can be made
+  # to the card. If you just attempt to store the card, and you get a valid
+  # response, it just means that the card data had no syntactical errors,
+  # not that you could ACTUALLY charge the card.
+  # @param type [String] Required.
+  # @param number [String] Required.
+  # @param expire_month [Numeric] Required.
+  # @param expire_year [Numeric] Required.
+  # @param cvv2 [String] Required.
+  # @param first_name [String] Required.
+  # @param last_name [String] Required.
+  # @param line1 [String] Required if any other address fields are present.
+  # @param city [String] Required if any other address fields are present.
+  # @param state [String] Required if any other address fields are present.
+  # @param postal_code [String] Required if any other address fields are present.
+  # @param country_code [String] Required if any other address fields are present.
+  def validate_credit_card(type, number, expire_month, expire_year, cvv2, \
+    first_name, last_name, line1, city, state, postal_code, country_code)
+    data = ""
+    data << "{
+      'intent':'authorize',
+      'payer':{
+        'payment_method':'credit_card',
+        'funding_instruments':[
+          {
+            'credit_card':{
+              'number':'#{number}',
+              'type':'#{type}',
+              'expire_month':#{expire_month},
+              'expire_year':#{expire_year},
+              'cvv2':'#{cvv2}',
+              'first_name':'#{first_name}',
+              'last_name':'#{last_name}',"
+              if (!line1.empty?) || (!city.empty?) || (!state.empty?) || (!postal_code.empty?) || (!country_code.empty?)
+              data << "              'billing_address':{
+                'line1':'#{line1}',
+                'city':'#{city}',
+                'state':'#{state}',
+                'postal_code':'#{postal_code}',
+                'country_code':'#{country_code}'
+              }"
+              end
+          data << "            }
+          }
+        ]
+      },
+      'transactions':[
+        {
+          'amount':{
+            'total':0.01,
+            'currency':'USD'
+          },
+          'description':'This is a validation transaction.'
+        }
+      ]
+    }"
+    call_paypal("/v1/payments/payment", data)
+    if (@status.last=='201') && (@hash.last[:state]=='approved')
+      link = @hash.last[:transactions][0][:related_resources][0][:authorization][:links].select{|link| link[:rel]=='void'}
+      call_paypal(link[0][:href], nil, :method => :post, :reset => :no)
+      return true if (@status.last=='200') && (@hash.last[:state]=='voided')
+    end
+    return false
+  end
+end

data/lib/paypkg/version.rb

@@ -0,0 +1,3 @@
+module Version
+  VERSION = "0.1.1"
+end