confluency 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47eebce1e13ce2437c98fd143aadcd60040f2a81
-  data.tar.gz: 49342db0d644bc2fe3697b244070da9f21a4b4c3
+  metadata.gz: e3652c5ffe7813bbe9b5764072fdc788a4d0e0f7
+  data.tar.gz: 69a089300e7eff359531b2a806224ed2ceed5a55
 SHA512:
-  metadata.gz: 6b867af9717cc23e0a882b5b40eded3ea210da4662fc075a728b03213c6502635938f2db86be3962d2944aea710519d72f32b5f576feb2628ed0e326ce337ac9
-  data.tar.gz: 7ebb91a4f6008e5d1256b72d5372e212c310e26b21632f24928ccc8c2c39152ac8ebbc352185a2b13e6ba78137e2c96409cbf13956597730b982fcb5f8a56851
+  metadata.gz: 04ec95230a43e2e8acb9519dcf45de633e43610615e3452132c025e42972432ddfa88ab7cd50f9d951545eb0d61079df0cc1fbc540da47a9ef9d1bd0d355a595
+  data.tar.gz: 4327fd19c8b6203c0998f1ed5ff471e84904be1243f8ed7e848b43009938e8c96f7d2505733fc152c5ebe64f4d0130f5bb6b960936bfb9607c20f186cdc8aeb3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,6 +1,6 @@
 # Confluency
 
-TODO: Write a gem description
+Confluency serves as a client to connect to Confluence and treats you to some easy helper methods to format text for to meet [Confluence's storage format](https://confluence.atlassian.com/display/DOC/Confluence+Storage+Format)
 
 ## Installation
 
@@ -18,7 +18,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To Connect
+----------
+
+	client = Confluency::Client.new("CONFLUENCE_URL")
+	client.login("user","password")
+
+Remote Methods
+--------------
+
+These will allow you to do things to administer Confluence, i.e. Add spaces, change permissions, delete pages, etc.
+
+For a list of valid remote methods, please see [Confluence's list of remote methods](https://developer.atlassian.com/display/CONFDEV/Remote+Confluence+Methods) and note that the token can be ommited. The Confluency client already passes the token into the method.
+
+Helper Methods
+--------------
+
+These helper methods are intended to make formating document easier from you application.
+	
+	# String#to_heading
+	"HELLO".to_heading(3) # => <h3>HELLO</h3>
 
 ## Contributing
 

data/confluency.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
 end

data/lib/confluency.rb

@@ -1,5 +1,6 @@
 require "confluency/version"
 require "confluency/client"
+require "confluency/string"
 
 module Confluency
   # your code here

data/lib/confluency/client.rb

@@ -2,16 +2,17 @@ require 'xmlrpc/client'
 
 module Confluency
 	class Client
-		def initialize(url)
-			url += "/rpc/xmlrpc" unless url[-11..-1] == "/rpc/xmlrpc"
-			@url = url
-			server = XMLRPC::Client.new2(url)
-			@conf = server.proxy("confluence2")
-			@token = "12345"
-		end
-
-		def login(username, password)
-			@user = username
+		
+    def initialize(server_url)
+      server_url += "/rpc/xmlrpc" unless server_url[-11..-1] == "/rpc/xmlrpc"
+      @server_url = server_url
+      server = XMLRPC::Client.new2(server_url)
+      @conf = server.proxy("confluence2")
+      @token = "12345"
+    end
+  
+    def login(username, password)
+      @user = username
       @pass = password
       do_login()
     end
@@ -38,5 +39,5 @@ module Confluency
         raise e.faultString
       end
     end
-	end
-end
+  end
+end

data/lib/confluency/string.rb

@@ -0,0 +1,5 @@
+class String
+	def to_heading(num)
+		"<h#{num.to_s}>#{self}</h#{num.to_s}>"
+	end
+end

data/lib/confluency/version.rb

@@ -1,3 +1,3 @@
 module Confluency
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/client_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'confluency'
+
+describe Confluency::Client, '#new' do
+
+	before :each do 
+		url = 'http://localhost'
+		@client = Confluency::Client.new(url)
+	end
+
+	it "should not raise an error" do
+		username = 'admin'
+		password = 'password'
+		@client.login(username,password)
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/string_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'confluency'
+
+describe String, "#to_heading" do
+
+	before :each do	
+		@string = "This is my string"
+	end
+
+	it "should return a string as a head element" do
+		@string.to_heading(1).should == "<h1>#{@string}</h1>"
+	end
+
+	it "should return an <h3> if 3 is passed to to_heading" do
+		@string.to_heading(3).should == "<h3>#{@string}</h3>"
+	end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confluency
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nate West
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Confluency is a magical Ruby gem that's fluent in Confluence markup
 email:
 - natescott.west@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,7 +68,11 @@ files:
 - confluency.gemspec
 - lib/confluency.rb
 - lib/confluency/client.rb
+- lib/confluency/string.rb
 - lib/confluency/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb
 homepage: http://github.com/drumsrgr8forn8/confluency
 licenses:
 - MIT
@@ -78,4 +97,7 @@ rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Confluency will allow you to write to Confluence from another application
-test_files: []
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb