paymill 0.1.0 → 0.2.0

data/README.md

@@ -1,4 +1,4 @@
-Paymill ![Build status](http://travis-ci.org/dkd/paymill-ruby.png)
+Paymill [![Build Status](https://secure.travis-ci.org/dkd/paymill-ruby.png)](https://travis-ci.org/dkd/paymill-ruby)
 ======
 
 This is a Ruby wrapper for Paymill's API.
@@ -22,21 +22,31 @@ Now you can e.g. create a new client:
 
     Paymill::Client.create(email: "stefan.sprenger@dkd.de", description: "He is a Ruby guy.")
 
-Or find a existing client:
+Or find an existing client:
 
     Paymill::Client.find("client_88a388d9dd48f86c3136")
 
+Updating an existing client only works on an instance:
+
+    client = Paymill::Client.find("client_88a388d9dd48f86c3136")
+    client.update_attributes(email: "carl.client@example.com")
+
+Deleting a client:
+
+    Paymill::Client.delete("client_88a388d9dd48f86c3136")
+
+
 For retrieving a collection of all clients you might use the `all`
 operation:
 
     Paymill::Client.all
 
-We currently only support the operations `create`, `find` and `all`.
+Please note that Transactions and Payments cannot be updated.
 
 Requirements
 =====
 
-This gem was developed using Ruby 1.9 and version 2 of Paymill's API. Nonetheless, it should also work with Ruby 1.8.
+This gem requires Ruby 1.9 and faces version 2 of Paymill's API.
 
 Bugs
 ======

data/lib/paymill.rb

@@ -9,6 +9,7 @@ module Paymill
 
   @@api_key = nil
 
+  autoload :Base,         "paymill/base"
   autoload :Client,       "paymill/client"
   autoload :Offer,        "paymill/offer"
   autoload :Payment,      "paymill/payment"
@@ -18,8 +19,9 @@ module Paymill
   module Operations
     autoload :All,    "paymill/operations/all"
     autoload :Create, "paymill/operations/create"
-    autoload :Delete, "paymill/operations/delete"
     autoload :Find,   "paymill/operations/find"
+    autoload :Update, "paymill/operations/update"
+    autoload :Delete, "paymill/operations/delete"
   end
 
   class PaymillError < StandardError
@@ -40,22 +42,24 @@ module Paymill
     def request(http_method, api_url, data)
       raise AuthenticationError if api_key.nil?
 
-      https              = Net::HTTP.new(API_BASE, Net::HTTP.https_default_port)
-      https.use_ssl      = true
-      https.verify_mode  = OpenSSL::SSL::VERIFY_PEER
-      https.ca_file      = File.join(File.dirname(__FILE__), "data/paymill.crt")
+      https             = Net::HTTP.new(API_BASE, Net::HTTP.https_default_port)
+      https.use_ssl     = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      https.ca_file     = File.join(File.dirname(__FILE__), "data/paymill.crt")
       https.start do |connection|
         url = "/#{API_VERSION}/#{api_url}"
         https_request = case http_method
               when :post
                 Net::HTTP::Post.new(url)
+              when :put
+                Net::HTTP::Put.new(url)
               when :delete
                 Net::HTTP::Delete.new(url)
               else
                 Net::HTTP::Get.new(url)
               end
-        https_request.basic_auth(api_key,"")
-        https_request.set_form_data(data) if http_method == :post
+        https_request.basic_auth(api_key, "")
+        https_request.set_form_data(data) if [:post, :put].include? http_method
         @response = https.request(https_request)
       end
       raise AuthenticationError if @response.code.to_i == 401

data/lib/paymill/base.rb

@@ -0,0 +1,17 @@
+module Paymill
+  class Base
+    include Paymill::Operations::All
+    include Paymill::Operations::Create
+    include Paymill::Operations::Find
+
+    def initialize(attributes = {})
+      set_attributes(attributes)
+    end
+
+    def set_attributes(attributes)
+      attributes.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+  end
+end

data/lib/paymill/client.rb

@@ -1,17 +1,9 @@
 module Paymill
-  class Client
-    include Paymill::Operations::All
-    include Paymill::Operations::Create
+  class Client < Base
     include Paymill::Operations::Delete
-    include Paymill::Operations::Find
+    include Paymill::Operations::Update
 
     attr_accessor :id, :email, :description, :attributes, :created_at,
                   :updated_at, :payment, :subscription
-
-    def initialize(attributes = {})
-      attributes.each_pair do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
   end
 end

data/lib/paymill/offer.rb

@@ -1,16 +1,8 @@
 module Paymill
-  class Offer
-    include Paymill::Operations::All
-    include Paymill::Operations::Create
+  class Offer < Base
     include Paymill::Operations::Delete
-    include Paymill::Operations::Find
+    include Paymill::Operations::Update
 
     attr_accessor :id, :name, :amount, :interval, :trial_period_days, :currency
-
-    def initialize(attributes = {})
-      attributes.each_pair do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
   end
 end

data/lib/paymill/operations/all.rb

@@ -2,7 +2,7 @@ module Paymill
   module Operations
     module All
       module ClassMethods
-        def all()
+        def all
           response = Paymill.request(:get, "#{self.name.split("::").last.downcase}s/", {})
           results = []
           response["data"].each do |obj|

data/lib/paymill/operations/update.rb

@@ -0,0 +1,10 @@
+module Paymill
+  module Operations
+    module Update
+      def update_attributes(attributes)
+        response = Paymill.request(:put, "#{self.class.name.split("::").last.downcase}s/#{id}", attributes)
+        set_attributes(response["data"])
+      end
+    end
+  end
+end

data/lib/paymill/payment.rb

@@ -1,16 +1,6 @@
 module Paymill
-  class Payment
-    include Paymill::Operations::All
-    include Paymill::Operations::Create
-    include Paymill::Operations::Find
-
+  class Payment < Base
     attr_accessor :id, :card_type, :country, :expire_month, :expire_year,
                   :card_holder, :last4, :created_at, :updated_at
-
-    def initialize(attributes = {})
-      attributes.each_pair do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
   end
 end

data/lib/paymill/subscription.rb

@@ -1,17 +1,9 @@
 module Paymill
-  class Subscription
-    include Paymill::Operations::All
-    include Paymill::Operations::Create
+  class Subscription < Base
     include Paymill::Operations::Delete
-    include Paymill::Operations::Find
+    include Paymill::Operations::Update
 
     attr_accessor :id, :plan, :livemode, :cancel_at_period_end, :created_at, :updated_at,
-                  :canceled_at, :client
-
-    def initialize(attributes = {})
-      attributes.each_pair do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
+                  :canceled_at, :client, :trial_start, :trial_end
   end
 end

data/lib/paymill/transaction.rb

@@ -1,16 +1,6 @@
 module Paymill
-  class Transaction
-    include Paymill::Operations::All
-    include Paymill::Operations::Create
-    include Paymill::Operations::Find
-
+  class Transaction < Base
     attr_accessor :id, :amount, :status, :description, :livemode,
-                  :payment, :client, :created_at, :updated_at
-
-    def initialize(attributes = {})
-      attributes.each_pair do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
+                  :payment, :currency, :client, :created_at, :updated_at
   end
 end

data/lib/paymill/version.rb

@@ -1,3 +1,3 @@
 module Paymill
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/paymill/client_spec.rb

@@ -43,4 +43,21 @@ describe Paymill::Client do
       Paymill::Client.create(valid_attributes)
     end
   end
+
+  describe "#update_attributes" do
+    it "makes a new PUT request using the correct API endpoint" do
+      client.id = "client_123"
+      Paymill.should_receive(:request).with(:put, "clients/client_123", {:email => "tim.test@exmaple.com"}).and_return("data" => {})
+
+      client.update_attributes({:email => "tim.test@exmaple.com"})
+    end
+
+    it "updates the instance with the returned attributes" do
+      changed_attributes = {:email => "tim.test@example.com"}
+      Paymill.should_receive(:request).and_return("data" => changed_attributes)
+      client.update_attributes(changed_attributes)
+
+      client.email.should eql("tim.test@example.com")
+    end
+  end
 end

data/spec/paymill/offer_spec.rb

@@ -3,10 +3,10 @@ require "spec_helper"
 describe Paymill::Offer do
   let(:valid_attributes) do
     {
-      amount: 4200,
+      amount:   4200,
       currency: "eur",
       interval: "month",
-      name: "Medium Plan"
+      name:     "Medium Plan"
     }
   end
 
@@ -50,4 +50,21 @@ describe Paymill::Offer do
       Paymill::Offer.create(valid_attributes)
     end
   end
+
+  describe "#update_attributes" do
+    it "makes a new PUT request using the correct API endpoint" do
+      offer.id = "offer_123"
+      Paymill.should_receive(:request).with(:put, "offers/offer_123", {:name => "Large Plan"}).and_return("data" => {})
+
+      offer.update_attributes({:name => "Large Plan"})
+    end
+
+    it "updates the instance with the returned attributes" do
+      changed_attributes = {:name => "Large Plan"}
+      Paymill.should_receive(:request).and_return("data" => changed_attributes)
+      offer.update_attributes(changed_attributes)
+
+      offer.name.should eql("Large Plan")
+    end
+  end
 end

data/spec/paymill/subscription_spec.rb

@@ -3,14 +3,16 @@ require "spec_helper"
 describe Paymill::Subscription do
   let(:valid_attributes) do
     {
-      plan: {
+      plan:                 {
         name:     "Nerd special",
         amount:   123,
         interval: "week"
       },
-      livemode: false,
+      livemode:             false,
+      trial_start:          1349945681,
+      trial_end:            1349945682,
       cancel_at_period_end: false,
-      client: {
+      client:               {
         email: "stefan.sprenger@dkd.de"
       }
     }
@@ -28,6 +30,8 @@ describe Paymill::Subscription do
       subscription.livemode.should be_false
       subscription.cancel_at_period_end.should be_false
       subscription.client[:email].should eql("stefan.sprenger@dkd.de")
+      subscription.trial_start.should eql(1349945681)
+      subscription.trial_end.should eql(1349945682)
     end
   end
 
@@ -58,4 +62,21 @@ describe Paymill::Subscription do
       Paymill::Subscription.create(valid_attributes)
     end
   end
+
+  describe "#update_attributes" do
+    it "makes a new PUT request using the correct API endpoint" do
+      changed_attributes = {:cancel_at_period_end => true}
+      subscription.id    = 'sub_123'
+
+      Paymill.should_receive(:request).with(:put, "subscriptions/sub_123", changed_attributes).and_return("data" => changed_attributes)
+
+      subscription.update_attributes(changed_attributes)
+    end
+
+    it "should set the returned attributes on the instance" do
+      Paymill.should_receive(:request).and_return("data" => {:cancel_at_period_end => true})
+      subscription.update_attributes({})
+      subscription.cancel_at_period_end.should be_true
+    end
+  end
 end

data/spec/paymill/transaction_spec.rb

@@ -4,6 +4,7 @@ describe Paymill::Transaction do
   let(:valid_attributes) do
     {
       amount: 4200,
+      currency: "EUR",
       status: "pending",
       description: "Test transaction.",
       livemode: false,
@@ -28,6 +29,7 @@ describe Paymill::Transaction do
       transaction.payment[:card_type].should eql("visa")
       transaction.payment[:country].should eql("germany")
       transaction.client.should eql("client_a013c")
+      transaction.currency.should eql("EUR")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paymill
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2153504740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2153504740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2153503800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,12 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2153503800
 description: API wrapper for Paymill.
 email:
 - stefan.sprenger@dkd.de
@@ -58,12 +48,14 @@ files:
 - Rakefile
 - lib/data/paymill.crt
 - lib/paymill.rb
+- lib/paymill/base.rb
 - lib/paymill/client.rb
 - lib/paymill/offer.rb
 - lib/paymill/operations/all.rb
 - lib/paymill/operations/create.rb
 - lib/paymill/operations/delete.rb
 - lib/paymill/operations/find.rb
+- lib/paymill/operations/update.rb
 - lib/paymill/payment.rb
 - lib/paymill/subscription.rb
 - lib/paymill/transaction.rb
@@ -90,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4192098067474741217
+      hash: 2201296574026171541
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,10 +91,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4192098067474741217
+      hash: 2201296574026171541
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: API wrapper for Paymill.