opensrs 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,8 +1,79 @@
 = OpenSRS
 
-Provides basic support to connect to, and utilise the OpenSRS API. More information on the API can be located here:
+Provides basic support to connect to, and utilise the OpenSRS API. This library has been well-tested in a high performance production
+environment. More information on the API can be located here:
 
-http://opensrs.com/resources/documentation/subreseller_xmlapi.pdf
+http://opensrs.com/resources/documentation/opensrs_xmlapi.pdf
+
+== Installation
+
+You can install this gem by doing the following:
+
+    $ gem install opensrs
+    
+You can then include it in a Ruby project, like so:
+
+    require 'opensrs'
+    
+Alternatively, you can include it in a Rails project in the <tt>environment.rb</tt> file, like so:
+
+    config.gem "opensrs"
+
+== Usage
+
+This library provides basic functionality for interacting with the OpenSRS XML API.
+
+* Connection handling
+* Error reporting
+* XML encoding
+* XML decoding
+
+To connect, instantiate a new OpenSRS::Server object:
+
+    server = OpenSRS::Server.new(
+      :server => "https://rr-n1-tor.opensrs.net:55443/",
+      :username => "testing",
+      :password => "53cr3t",
+      :key => "c633be3170c7fb3fb29e2f99b84be24107b37e206663967f8cdfarandomc17d411fc28b3dbff47d03c51c61279bd6f3c545a3210777ab93b44e6aef5e23d82"
+    )
+    
+Once you have this, you can build from this to create the methods that you need. For instance, let's say we want to grab our balance. The
+OpenSRS XML API takes a couple of attributes for all commands. You can include those here:
+
+    def get_balance
+      server.call(
+        :action => "GET_BALANCE",
+        :object => "BALANCE"
+      )
+    end
+    
+Sometimes you might need to include attributes for the command, such as a cookie, or the data attributes themselves. You can do this, too:
+
+    def create_nameserver(nameserver)
+      server.call(
+        :action => "CREATE",
+        :object => "NAMESERVER",
+        :cookie => "366828736:3210384",
+        :attributes => {
+          :name => nameserver.hostname,
+          :ipaddress => "212.112.123.11"
+        }
+      )
+    end
+    
+Responses from OpenSRS are returned in an OpenSRS::Response object, which gives you access to a multitude of things.
+
+* <tt>response.response</tt> - This gives you the response in a Hash form, which is highly accessible to most other actions in your application.
+* <tt>response.errors</tt> - If there are errors which come back from OpenSRS, they are returned here. If not, it returns nil.
+* <tt>response.success?</tt> - Returns true if the response was labeled as successful. If not, it returns false.
+* <tt>response.request_xml</tt> - Returns raw request XML.
+* <tt>response.response_xml</tt> - Returns raw response XML.
+
+== Bugs/Feature Requests
+
+If you have any bugs or feature requests for this gem, feel free to add them in the Issues portion of the GitHub repository here:
+
+http://github.com/voxxit/opensrs/issues
 
 == Note on Patches/Pull Requests
  

data/VERSION

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

data/lib/opensrs/response.rb

@@ -1,10 +1,13 @@
 module OpenSRS
   class Response
+    attr_reader :request_xml, :response_xml
     attr_accessor :response, :success
     
-    def initialize(response)
-      @response = response
-      @success = success?
+    def initialize(parsed_response, request_xml, response_xml)
+      @response     = parsed_response
+      @request_xml  = request_xml
+      @response_xml = response_xml
+      @success      = success?
     end
   
     # We need to return the error message unless the

data/lib/opensrs/server.rb

@@ -15,17 +15,16 @@ module OpenSRS
     end
 
     def call(options = {})
-      xml = OpenSRS::XML.build({
-        :protocol   => "XCP",
-        :action     => options[:action],
-        :object     => options[:object],
-        :attributes => options[:attributes]
-      })
+      attributes = {
+        :protocol => "XCP"
+      }
+      
+      xml = OpenSRS::XML.build(attributes.merge!(options))
       
       response = http.post(server.path, xml, headers(xml))
       parsed_response = OpenSRS::XML.parse(response.body)
       
-      return OpenSRS::Response.new(parsed_response)
+      return OpenSRS::Response.new(parsed_response, xml, response.body)
     end
     
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: opensrs
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Josh Delsman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 +00:00
+date: 2010-02-06 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency