interfax 0.1.0 → 0.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Sascha Brink
+Copyright (c) 2010 Sascha Brink
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -0,0 +1,60 @@
+# Interfax/Ruby
+
+This library is a wrapper for the interfax.net fax service. Until now only sending of html faxes and status 
+querying is supported.
+
+If you're willing to help, just drop me a line.
+
+## Sending
+
+Creating a fax:
+
+    fax = OrderFax.new(:html).contains("<h1>test</h1>").subject("test").to("+4923456123456")
+
+It is possible to specify more than one receipent:
+
+    fax = OrderFax.new(:html).contains("<h1>test</h1>").subject("test").to(["+4923456123456","+4943254324312"])
+
+To get a summary before sending, just call summary on it which returns a hash:
+
+    fax.summary
+
+Finally:
+
+    result_id = fax.deliver
+
+## Querying
+
+To get all faxes:
+
+    faxes = OrderFax.all
+  
+You can limit the number of received items with an optional parameter:
+    
+    faxes = OrderFax.all(10)
+
+To find a specific fax:
+
+    OrderFax.find(123456789)
+
+or get more than one at once:
+
+    OrderFax.find(123456789,234567890)
+
+## Interfax API documentation
+
+http://www.interfax.net/en/dev/webservice/reference/methods
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Sascha Brink. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/interfax/base.rb

@@ -116,16 +116,4 @@ module Interfax
     
   end
 
-end
-
-
-# 
-# aa = OrderFax.new(:html).contains("<h1>test</h1>").subject("yes").to("+49236189013699")
-# aa.summary
-# aa.deliver
-# 
-# OrderFax.all
-# OrderFax.find(173581304)
-# 
-# 
-
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: interfax
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sascha Brink
@@ -42,10 +42,10 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/interfax.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= interfax
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Sascha Brink. See LICENSE for details.