citrulu 0.1.0 → 0.1.1

data/README.md

@@ -1,17 +1,69 @@
 Citrulu
 =======
-A wrapper for the [Citrulu api](https://www.citrulu.com/api)
+
+[Citrulu](https://www.citrulu.com/) exposes an [api](https://www.citrulu.com/api) for creating, editing and compiling test files. This gem provides a wrapper around that api which allows you to work with TestFile objects locally.
+
+The gem has not yet been widely used. It's probably very unlikely to cause anything bad to happen in your app, but please **use at your own risk** and raise an issue if you find any bugs.
+
+Installation
+-------------
+
+    gem install citrulu
+    
+Or in your gemfile:
+
+```ruby
+gem "citrulu"
+```    
+
+Setup
+-----
+
+You need an account on Citrulu to use the gem: Sign up at <http://www.citrulu.com>, and once you're signed in you can create an API key on the '[Account Settings](https://www.citrulu.com/settings)' page.
+ 
+Configure your API key by adding it to an initializer: 
+
+```ruby
+#config/initializers/citrulu_auth.rb
+CITRULU_API_KEY = "abcdefgh"
+```
 
 Usage
 -----
-You need an account on Citrulu to use the gem. Sign up at <http://www.citrulu.com>.
 
-You can create an API key on the '[Account Settings](https://www.citrulu.com/settings)' tab once you're signed in. 
+You can interact with TestFile instances in mostly the same way that you'd interact with a Rails model:
 
-Configure your API key by adding the following to an initializer, eg. `config/initializers/citrulu_auth.rb`:
+List test files
 
 ```ruby
-CITRULU_API_KEY = "abcdefgh"
+TestFile.all
+```
+    
+Create a new test file
+
+```ruby    
+test_file = TestFile.new( name:           "My first test file",
+                          test_file_text: "On http://www.google.com",
+                          run_tests:      "true" )
+test_file.save
+
+# test files must have be successfully compiled before they will be run:
+test_file.compile
+```
+    
+Find a specific test file by and update it:
+
+```ruby 
+test_file = TestFile.find(23)
+test_file.update(run_tests: false)
+test_file.save
+```    
+
+Delete a test file:
+
+```ruby 
+test_file = TestFile.find(23)
+test_file.destroy
 ```
 
 Contributing to the Citrulu gem 
@@ -28,6 +80,8 @@ Authors
 -------
 Duncan Stuart (duncan@dxw.com)
 
+contact@dxw.com
+
 Copyright
 ---------
-Copyright (c) 2012 The Dextrous Web Ltd. See LICENSE.txt for further details.
+Copyright (c) 2012 The Dextrous Web Ltd. See LICENSE.txt for further details.

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "citrulu"
   gem.homepage = "https://github.com/dxw/citrulu-api-ruby.git"
   gem.license = "MIT"
-  gem.summary = %Q{ Wrapper for the api exposed by Citrulu }
-  gem.description = %Q{ Citrulu exposes an api for creating, editing and compiling test files (http://www.citrulu.com/api). This gem provides a wrapper around that api which allows you to work with TestFile objects locally. }
+  gem.summary = %Q{Wrapper for the api exposed by Citrulu}
+  gem.description = %Q{Citrulu exposes an api for creating, editing and compiling test files (http://www.citrulu.com/api). This gem provides a wrapper around that api which allows you to work with TestFile objects locally.}
   gem.email = ["contact@dxw.com", "duncan@dxw.com"]
   gem.authors = ["Duncan Stuart"]
   # dependencies defined in Gemfile
@@ -38,12 +38,12 @@ end
 
 task :default => :spec
 
-# require 'rdoc/task'
-# Rake::RDocTask.new do |rdoc|
-#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
-# 
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title = "citrulu-api #{version}"
-#   rdoc.rdoc_files.include('README*')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "citrulu-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/citrulu.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "citrulu"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Duncan Stuart"]
   s.date = "2012-10-29"
-  s.description = " Citrulu exposes an api for creating, editing and compiling test files (http://www.citrulu.com/api). This gem provides a wrapper around that api which allows you to work with TestFile objects locally. "
+  s.description = "Citrulu exposes an api for creating, editing and compiling test files (http://www.citrulu.com/api). This gem provides a wrapper around that api which allows you to work with TestFile objects locally."
   s.email = ["contact@dxw.com", "duncan@dxw.com"]
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/citrulu.rb

@@ -3,9 +3,10 @@ Dir[File.expand_path('../faraday/*.rb', __FILE__)].each{|f| require f}
 require 'faraday'
 
 module Citrulu
+  # The address of the Citrulu API
   BASE_URL = "https://www.citrulu.com/api/v1"
-  # BASE_URL = "http://localhost:3000/api/v1"
   
+  # Sets up the connection to the Citrulu API using the api key, which must already have been set to CITRULU_API_KEY
   def self.connection
     Faraday.new(:url => BASE_URL) do |connection|
       connection.request  :url_encoded             # form-encode POST params

data/lib/citrulu/error.rb

@@ -1,4 +1,4 @@
-module Citrulu
+module Citrulu #:nodoc:
   # Custom error class for rescuing from all Citrulu errors
   class Error < StandardError; end
 

data/lib/citrulu/test_file.rb

@@ -4,18 +4,25 @@ require 'active_model'
 class TestFile
   attr_accessor :name
   attr_accessor :test_file_text
+  # The tests which will be run. May differ from test_file_text if the
   attr_reader :compiled_test_file_text
+  # Boolean - if set to true, the tests will be run
   attr_accessor :run_tests
+  # The list of domains in compiled_test_file_text
   attr_reader :domains
+  # How often the test file is run, in seconds (e.g. 3600 = once every hour)
   attr_reader :frequency
   attr_reader :id
   attr_reader :tutorial_id
   attr_reader :updated_at
   attr_reader :created_at
   
+  # A rails style error object (using ActiveModel::Errors) - use errors.full_messages to access an array of error messages
   attr_reader :errors
   
-  def self.attribute_method?(attribute)
+  protected
+  
+  def self.attribute_method?(attribute) #:nodoc:
     [ :name,
       :test_file_text,
       :compiled_test_file_text,
@@ -29,27 +36,38 @@ class TestFile
     ].include?(attribute)
   end
   
+  public
+  
   extend ActiveModel::Naming 
   # Required dependency for ActiveModel::Errors
   
-  # This is for the user creating Test Files. Internally we use build (defined below)
-  def initialize(args={})
-    args.each do |attr, value|
-      self.public_send("#{attr}=", value)
-    end if args
+  class << self
+    private
+    
+    # Required in order for ActiveModel::Errors to work correctly
+    def self.human_attribute_name(attr, options = {})
+      attr
+    end
+
+    # Required in order for ActiveModel::Errors to work correctly
+    def self.lookup_ancestors
+      [self]
+    end
   end
   
-  # The following methods are needed in order for ActiveModel::Errors to work correctly
+  private
+
+  # Required in order for ActiveModel::Errors to work correctly
   def read_attribute_for_validation(attr)
     send(attr)
   end
-
-  def self.human_attribute_name(attr, options = {})
-    attr
-  end
-
-  def self.lookup_ancestors
-    [self]
+  
+  public
+  
+  def initialize(args={})
+    args.each do |attr, value|
+      self.public_send("#{attr}=", value)
+    end if args
   end
   
   
@@ -84,7 +102,7 @@ class TestFile
       build(body)
     else # 422 - validation errors
       test_file = build(options)
-      test_file.add_all_errors(body["errors"])
+      add_all_errors(test_file, body["errors"])
       return test_file
     end
   end
@@ -98,7 +116,7 @@ class TestFile
       build(body)
     else # 422 - validation errors
       test_file = find(id)
-      test_file.add_all_errors(body["errors"])
+      add_all_errors(test_file, body["errors"])
       return test_file
     end
   end
@@ -121,7 +139,7 @@ class TestFile
   # Instance Methods #
   ####################
   
-  # Create or update the current object
+  # Create or update the current test file on Citrulu
   def save
     options = { name:           name,
                 test_file_text: test_file_text,
@@ -134,10 +152,12 @@ class TestFile
     end
   end
   
+  # Deletes the current test file on Citrulu
   def destroy
     self.class.delete(id)
   end
   
+  # Attempts to compile the test file. Returns any compilation errors as an errors object. Use errors.full_messages to access the array of error messages.
   def compile
     self.class.compile(id)
   end
@@ -150,7 +170,6 @@ class TestFile
   # Utility Methods #
   ####################
   
-  #TODO: really not sure about this...
   class << self
     private
     
@@ -165,17 +184,17 @@ class TestFile
       return test_file
     end
     
+    def add_all_errors(test_file, error_hash)
+      error_hash.each do |attribute, messages|
+        messages.each do |message|
+          test_file.errors.add(attribute.to_sym, message)
+        end
+      end
+    end
+    
     def parse_response(json)
       attrs = JSON.parse(json)
       build(attrs)
-    end
-  end
-  
-  def add_all_errors(error_hash)
-    error_hash.each do |attribute, messages|
-      messages.each do |message|
-        errors.add(attribute.to_sym, message)
-      end
-    end
+    end    
   end
 end

data/lib/faraday/raise_error.rb

@@ -5,6 +5,7 @@ require 'faraday'
 
 module FaradayMiddleware
   class RaiseHttpException < Faraday::Middleware
+    # Handle response codes 401, 404 and 500 as exceptions. See https://github.com/technoweenie/faraday#writing-middleware for more details.
     def call(env)
       @app.call(env).on_complete do |response|
         case response[:status].to_i

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: citrulu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -155,9 +155,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! ' Citrulu exposes an api for creating, editing and compiling test files
+description: Citrulu exposes an api for creating, editing and compiling test files
   (http://www.citrulu.com/api). This gem provides a wrapper around that api which
-  allows you to work with TestFile objects locally. '
+  allows you to work with TestFile objects locally.
 email:
 - contact@dxw.com
 - duncan@dxw.com
@@ -199,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1427762494516547865
+      hash: -1012160131491449687
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: