paymill 0.2.2 → 0.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0

data/README.md

@@ -73,4 +73,4 @@ Note on Patches/Pull Requests
 Copyright
 ======
 
-Copyright (c) 2012 dkd Internet Service GmbH, Stefan Sprenger. See LICENSE for details.
+Copyright (c) 2012-2013 dkd Internet Service GmbH, Stefan Sprenger. See LICENSE for details.

data/lib/paymill.rb

@@ -4,20 +4,20 @@ require "json"
 require "paymill/version"
 
 module Paymill
-  API_BASE    = "api.paymill.de"
+  API_BASE    = "api.paymill.com"
   API_VERSION = "v2"
 
   @@api_key = nil
 
-  autoload :Base,         "paymill/base"
-  autoload :Client,       "paymill/client"
-  autoload :Offer,        "paymill/offer"
-  autoload :Payment,      "paymill/payment"
+  autoload :Base,             "paymill/base"
+  autoload :Client,           "paymill/client"
+  autoload :Offer,            "paymill/offer"
+  autoload :Payment,          "paymill/payment"
   autoload :Preauthorization, "paymill/preauthorization"
   autoload :Refund,           "paymill/refund"
-  autoload :Subscription, "paymill/subscription"
-  autoload :Transaction,  "paymill/transaction"
-  autoload :Webhook,      "paymill/webhook"
+  autoload :Subscription,     "paymill/subscription"
+  autoload :Transaction,      "paymill/transaction"
+  autoload :Webhook,          "paymill/webhook"
 
   module Operations
     autoload :All,    "paymill/operations/all"
@@ -34,14 +34,26 @@ module Paymill
   class APIError            < PaymillError; end
 
   class << self
+    # Returns the set api key
+    #
+    # @return [String] The api key
     def api_key
       @@api_key
     end
 
+    # Sets the api key
+    #
+    # @param [String] api_key The api key
     def api_key=(api_key)
       @@api_key = api_key
     end
 
+    # Makes a request against the Paymill API
+    #
+    # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
+    # @param [String] api_url The API url to use
+    # @param [Hash] data The data to send, e.g. used when creating new objects.
+    # @return [Array] The parsed JSON response.
     def request(http_method, api_url, data)
       raise AuthenticationError if api_key.nil?
 
@@ -79,6 +91,11 @@ module Paymill
       data
     end
 
+    # Builds and encodes a URI using given path and params.
+    #
+    # @param [String] path The path to use
+    # @param [Array] params The params to use
+    # @return [String] The built URI.
     def path_with_params(path, params)
       unless params.empty?
         encoded_params = URI.encode_www_form(params)

data/lib/paymill/base.rb

@@ -6,17 +6,24 @@ module Paymill
 
     attr_accessor :created_at, :updated_at
 
+    # Initializes the object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
     def initialize(attributes = {})
       set_attributes(attributes)
       parse_timestamps
     end
 
+    # Sets the attributes
+    #
+    # @param [Hash] attributes The attributes to initialize
     def set_attributes(attributes)
       attributes.each_pair do |key, value|
         instance_variable_set("@#{key}", value)
       end
     end
 
+    # Parses UNIX timestamps and creates Time objects.
     def parse_timestamps
       @created_at = Time.at(created_at) if created_at
       @updated_at = Time.at(updated_at) if updated_at

data/lib/paymill/operations/all.rb

@@ -2,6 +2,10 @@ module Paymill
   module Operations
     module All
       module ClassMethods
+        # Retrieves all available objects from the Paymill API
+        #
+        # @param [Hash] options Options to pass to the API
+        # @return [Array] The available objects
         def all(options = {})
           response = Paymill.request(:get, "#{self.name.split("::").last.downcase}s/", options)
           results = []

data/lib/paymill/operations/create.rb

@@ -2,6 +2,9 @@ module Paymill
   module Operations
     module Create
       module ClassMethods
+        # Creates a new object
+        #
+        # @param [Hash] attributes The attributes of the created object
         def create(attributes)
           response = Paymill.request(:post, "#{self.name.split("::").last.downcase}s", attributes)
           self.new(response["data"])
@@ -13,4 +16,4 @@ module Paymill
       end
     end
   end
-end
+end

data/lib/paymill/operations/delete.rb

@@ -2,6 +2,9 @@ module Paymill
   module Operations
     module Delete
       module ClassMethods
+        # Deletes the given object
+        #
+        # @param [Integer] id The id of the object that gets deleted
         def delete(id)
           response = Paymill.request(:delete, "#{self.name.split("::").last.downcase}s/#{id}", {})
           true
@@ -13,4 +16,4 @@ module Paymill
       end
     end
   end
-end
+end

data/lib/paymill/operations/find.rb

@@ -2,6 +2,10 @@ module Paymill
   module Operations
     module Find
       module ClassMethods
+        # Finds a given object
+        #
+        # @param [Integer] id The id of the object that should be found
+        # @return [Paymill::Base] The found object
         def find(id)
           response = Paymill.request(:get, "#{self.name.split("::").last.downcase}s/#{id}", {})
           self.new(response["data"])
@@ -13,4 +17,4 @@ module Paymill
       end
     end
   end
-end
+end

data/lib/paymill/operations/update.rb

@@ -1,6 +1,9 @@
 module Paymill
   module Operations
     module Update
+      # Updates a object
+      #
+      # @param [Hash] attributes The attributes that should be updated
       def update_attributes(attributes)
         response = Paymill.request(:put, "#{self.class.name.split("::").last.downcase}s/#{id}", attributes)
         set_attributes(response["data"])

data/lib/paymill/subscription.rb

@@ -3,8 +3,9 @@ module Paymill
     include Paymill::Operations::Delete
     include Paymill::Operations::Update
 
-    attr_accessor :id, :plan, :livemode, :cancel_at_period_end, :canceled_at, :client, :trial_start, :trial_end
+    attr_accessor :id, :offer, :livemode, :cancel_at_period_end, :canceled_at, :client, :trial_start, :trial_end
 
+    # Parses UNIX timestamps and creates Time objects
     def parse_timestamps
       super
       @canceled_at = Time.at(canceled_at) if canceled_at

data/lib/paymill/version.rb

@@ -1,3 +1,3 @@
 module Paymill
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/paymill/subscription_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Paymill::Subscription do
   let(:valid_attributes) do
     {
-      plan:                 {
+      offer:                {
         name:     "Nerd special",
         amount:   123,
         interval: "week"
@@ -24,9 +24,9 @@ describe Paymill::Subscription do
 
   describe "#initialize" do
     it "initializes all attributes correctly" do
-      subscription.plan[:name].should eql("Nerd special")
-      subscription.plan[:amount].should eql(123)
-      subscription.plan[:interval].should eql("week")
+      subscription.offer[:name].should eql("Nerd special")
+      subscription.offer[:amount].should eql(123)
+      subscription.offer[:interval].should eql("week")
       subscription.livemode.should be_false
       subscription.cancel_at_period_end.should be_false
       subscription.client[:email].should eql("stefan.sprenger@dkd.de")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paymill
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-09 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -99,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 216517499575340974
+      hash: 957344793951118701
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 216517499575340974
+      hash: 957344793951118701
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19