somefixtures 0.1.6 → 0.2.0

data/README.md

@@ -13,6 +13,32 @@ Install
 
 Usage
 -----
+
+Create a fixture object with the necessary details. The example given
+is from github, if you need to authenticate, supply your github username and
+password.
+
+Format:
+
+	Fixture.new
+
+Takes the following parameters:
+
+	:save_to
+	Location to save to. 
+	
+	:format
+	Format expected to be returned. (Only used for adding a file extension at the moment.)
+	
+	:base_uri
+	The base URI location to the API/Service. 
+
+	:login
+	:token
+	Your authentication details. 
+	
+Example: 
+
 	foo = Fixture.new( 
                     :save_to => "/Users/jbw/Desktop/", 
                     :format  => "json"
@@ -20,15 +46,50 @@ Usage
                     :login => "jbw", 
                     :token => "account_password" )
 
-	foo.add(:get, "/user/search/jbw", "search")
-	foo.add_get("/user/search/jbw", "search")
+The following shows some examples of adding fixtures to a data structure. 
+
+Format:
+
+	add_get
 
-	foo.add_get("/user/show/jbw", "show_unauthenticated")
-	foo.add_get("/user/show", "show_authenticated", true)
-	foo.add_get("/user/show/jbw/followers", "followers")
+	
+Takes the following: 
+
+	:route <Hash>
+	The API route.
+	
+	output_filename <String>
+	The name you want your file to have. 
+	
+	authenticate <Boolean>
+	Whether you need to authenticate with the server (Uses your :login, :token values).
+
+Format:
+
+	add_post
+			
+Takes the following: 
+	
+	:route <Hash>
+	output_filename <String>
+	authenticate <Boolean>
+    (See add_get)
+	
+	:values <Hash>
+	Values to post to the server. 
+
+
+Example:
+	
+    foo.add_get( { :route => "/user/show/jbw" }, "show")                                                                                                       
+                                                                                                                                                              
+    foo.add_post({ :route => "/user/follow/jbw" }, "follow", true)                                                                                              
+                                                                                                                                                              
+    foo.add_post({ :route => "/repos/show/jbw/emacs", :values => "values[description]=My Emacs configs" },"repo_update_description", true )                     
+                                                                                                                                                              
 
-	foo.add(:post, "/user/follow/jbw", "follow", true) 
-	foo.add_post("/user/follow/jbw", "follow", true)
+Once all the routes are added you can execute the following command to fetch
+the fixtures:
 
 	foo.make_fixtures!
 	
@@ -38,6 +99,5 @@ MIT
 
 TODO
 ----
-* Make more generic
 * Documentation
 

data/Rakefile

@@ -2,8 +2,8 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
   s.name        = 'somefixtures'
-  s.version     = '0.1.5'
-  s.date        = '2010-07-30'
+  s.version     = '0.2.0'
+  s.date        = '2010-08-08'
   s.description = "Testing fixture automator. Easies the pain of getting sample data for testing."
   s.summary     = s.description
   

data/lib/somefixtures/fixture.rb

@@ -1,6 +1,8 @@
 require 'net/http'
 module SomeFixtures
   class Fixture
+
+    attr_accessor :format, :base_uri, :save_to, :login, :token, :fixtures
     
     def initialize fixture_info
       @format   = fixture_info[:format]
@@ -12,78 +14,69 @@ module SomeFixtures
       @fixtures = {}
     end
     
-    def add option, query, name, authenticate=false
-      @fixtures.each_key { |key| print name == key ? "You have added \"#{key}\" for a file name already. Each filename must be unique!\n" : nil  }
-      @fixtures[name] = { :option => option, :query => query, :authenticate => authenticate }
-    end
-    
+    def add_post(*args); add_fixture(:post,  *args) end
+    def add_get(*args);  add_fixture(:get,   *args) end
 
     def make_fixtures!
-      save query 
+      save query_fixtures
     end
     
-    def add_post(*args); add(:post, *args) end
-    def add_get(*args); add(:get, *args) end
-    
     private
-    
-    def query
+    def is_duplicate? name
+      value = false
+      @fixtures.each_key{ |key| value = true if key == name }
+      print "WARNING: You have added a file named: \"#{name}\" already. Each filename must be unique!\n" if value
+      return value
+    end
+    def add_fixture option, query, name, authenticate=false
+      return true if is_duplicate? name
+      @fixtures[name]  = { :option => option, :query => query, :authenticate => authenticate }
+    end   
+    def query_fixtures
       responses = []
-      @fixtures.each_key do |name|
-        if @fixtures[name][:option] == :post
-          responses << (post name)
+      @fixtures.each_key do |fixture|
+        if @fixtures[fixture][:option] == :post
+          responses << ( post fixture )
         else
-          responses << (get name)
+          responses << ( get fixture )
         end
       end
       responses
     end
-     
-    def authenticated? name
-      @authenticate = @fixtures[name][:authenticate]; 
-      auth_params
-    end
-
-    def get name
-      Net::HTTP.start((split_uri @base_uri)[1]) do |http|     
-        req = Net::HTTP::Get.new((split_uri @base_uri)[2] + @fixtures[name][:query])
-        if @fixtures[name][:authenticate] == true
-          req.basic_auth (authenticated? name)[:login], (authenticated? name)[:token]
-        else
-          req.basic_auth @login, @token
-        end        
-        response = http.request(req)
-        response.body 
+    def get fixture
+      Net::HTTP.start(get_uri[:location]) do |http|     
+        request = Net::HTTP::Get.new(get_uri[:route] + @fixtures[fixture][:query][:route])
+        authenticate_if_values_given fixture, request
+        response = http.request(request)
+        return response.body 
       end
     end
-    
-    def post name
-      Net::HTTP.start((split_uri @base_uri)[1]) do |http| 
-        req = Net::HTTP::Post.new((split_uri @base_uri)[2] + @fixtures[name][:query])
-        req.basic_auth @login, @token
-        response = http.request(req)
-        response.body
+    def post fixture
+      Net::HTTP.start(get_uri[:location]) do |http| 
+        request = Net::HTTP::Post.new(get_uri[:route] + @fixtures[fixture][:query][:route])
+        request.body = @fixtures[fixture][:query][:values]
+        authenticate_if_values_given fixture, request
+        response = http.request(request)
+        return response.body
       end
     end
-    
-    def split_uri uri
-      if uri.match(/(http:\/\/)([a-zA-Z.]+)([a-zA-Z\d\/]+)/)
-        [$1, $2, $3]
+    def get_uri 
+      if @base_uri.match(/(http:\/\/)([a-zA-Z.]+)([a-zA-Z\d\/]+)/)
+        { :location => $2, :route => $3 }
       end
     end
-    
     def save fixtures
       name = @fixtures.keys
-
       fixtures.each do |f|
-        File.new(@save_to + name.first + "." + @format, "w").puts f
+        File.new(File.join(@save_to, name.first + "." + @format), "w").puts f
         name.shift
-      end  
-    end
-
-    def auth_params 
-      if @authenticate; (@login.nil? ? {} : { :login => @login, :token => @token }); end
+        return f.gsub("\"", "")
+      end
     end
-
+    def authenticate_if_values_given fixture, request
+      if @fixtures[fixture][:authenticate] == true
+        request.basic_auth @login, @token
+      end
+    end 
   end
 end

data/somefixtures.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'somefixtures'
-  s.version     = '0.1.6'
-  s.date        = '2010-07-30'
+  s.version     = '0.2.0'
+  s.date        = '2010-08-08'
   s.description = "Testing fixture automator. Easies the pain of getting sample data for testing."
   s.summary     = s.description
   

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 6
-  version: 0.1.6
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason Watson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-30 00:00:00 +01:00
+date: 2010-08-08 00:00:00 +01:00
 default_executable: 
 dependencies: []