diplomat 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6993773f2f540cc308337c3a47845e08201dcd93
-  data.tar.gz: 238df4c5465672f23f182c68d1e5a87ecc1b7928
+  metadata.gz: 0b5924c554f204f0f00a71f77090169cbeb928a8
+  data.tar.gz: a9e9948fede1773e4ba478e2d0fee89bb0c7f458
 SHA512:
-  metadata.gz: a1f2fd67dcdc5feb723c3ad660c2a971f5587726744007a10f7990d0682a4fbb33a6ce7f1ff1780798ad3b8254364e185ab500c8b9c603003468d9fa33fad4e9
-  data.tar.gz: 8619604f40bda32375f708a2b994c9a4f3590f480305f563ec376dc36b6ab84a90633511616234fb4789cfd6f0dccd386b46618e52e61a61542e0f0119db19f3
+  metadata.gz: 18294edda32703b3a028b8b13b643140523b994234c0ad4ae753d453ccdb48b78170c35033deb4747f8320361519cbd85e1191dd99f0d0c9ba33619450604ee6
+  data.tar.gz: e0a36c34a5669ff929fb6c6ca011bc8d40ccb535064be2dc16d311d5078aa60b070b251c08b6c27195c2a8a19b47b3ea0a47f27e64c1008612ab7b3fdc63f346

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+    - "1.9.3"
+    - "2.0.0"
+    - "2.1.0"
+addons:
+    code_climate:
+        repo_token: 17481039ac7b5ef8779ab644b28a4d95dd7523c3c1fee560311eb4af63de006f

data/Gemfile.lock

@@ -1,14 +1,17 @@
 PATH
   remote: .
   specs:
-    diplomat (0.0.3)
-      faraday (~> 0.9.0)
+    diplomat (0.1.3)
+      faraday (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.3.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.3)
     fakes (1.1.4)
     fakes-rspec (1.0.5)
       fakes
@@ -16,6 +19,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     json (1.8.1)
     method_source (0.8.2)
+    multi_json (1.9.2)
     multipart-post (2.0.0)
     pry (0.9.12.6)
       coderay (~> 1.0)
@@ -30,6 +34,11 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.4.7)
 
 PLATFORMS
@@ -37,9 +46,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  codeclimate-test-reporter
   diplomat!
-  fakes-rspec
-  json
-  pry
-  rake
-  rspec
+  fakes-rspec (~> 1.0)
+  json (~> 1.8)
+  pry (~> 0.9)
+  rake (~> 10.3)
+  rspec (~> 2.14)

data/README.md

@@ -1,5 +1,5 @@
 # Diplomat
-
+[![Gem Version](https://badge.fury.io/rb/diplomat.svg)](http://badge.fury.io/rb/diplomat) [![Build Status](https://travis-ci.org/johnhamelink/diplomat.svg?branch=master)](https://travis-ci.org/johnhamelink/diplomat) [![Code Climate](https://codeclimate.com/github/johnhamelink/diplomat.png)](https://codeclimate.com/github/johnhamelink/diplomat)
 ### A HTTP Ruby API for [Consul](http://www.consul.io/)
 
 ![Diplomacy Boad Game](http://i.imgur.com/Nkuy4b7.jpg)
@@ -41,6 +41,10 @@ production:
 
 ## Usage
 
+[The most up to date place to read about the API is here.](http://rubydoc.info/github/johnhamelink/diplomat)
+
+Here's a few examples of how diplomat works:
+
 ### Key Values
 
 #### Getting

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/diplomat.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "fakes-rspec", "~> 1.0"
   spec.add_development_dependency "json", "~> 1.8"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_dependency "faraday", "~> 0.9"
 end

data/lib/diplomat.rb

@@ -7,10 +7,7 @@ module Diplomat
     attr_accessor :url
 
     # Internal: Requires internal Faraday libraries.
-    #
-    # *libs - One or more relative String names to Faraday classes.
-    #
-    # Returns nothing.
+    # @param *libs One or more relative String names to Faraday classes.
     def require_libs(*libs)
       libs.each do |lib|
         require "#{lib_path}/#{lib}"

data/lib/diplomat/kv.rb

@@ -6,6 +6,9 @@ module Diplomat
 
     attr_reader :key, :value, :raw
 
+    # Get a value by it's key
+    # @param key [String] the key
+    # @return [String] The base64-decoded value associated with the key
     def get key
       @key   = key
       @raw   = @conn.get "/v1/kv/#{@key}"
@@ -14,28 +17,41 @@ module Diplomat
       return @value
     end
 
+    # Get a value by it's key
+    # @param key [String] the key
+    # @param value [String] the value
+    # @return [String] The base64-decoded value associated with the key
     def put key, value
-      @raw   = @conn.put "/v1/kv/#{@key}", @value
+      @raw = @conn.put do |req|
+        req.url "/v1/kv/#{@key}"
+        req.body = @value
+      end
       @raw   = JSON.parse(@raw.body).first
       @key   = @raw["Key"]
       @value = Base64.decode64(@raw["Value"])
       return @value
     end
 
+    # Delete a value by it's key
+    # @param key [String] the key
+    # @return [nil]
     def delete key
       @raw = @conn.delete "/v1/kv/#{@key}"
       @key   = nil
       @value = nil
     end
 
+    # @note This is sugar, see (#get)
     def self.get *args
       Diplomat::Kv.new.get *args
     end
 
+    # @note This is sugar, see (#put)
     def self.put *args
       Diplomat::Kv.new.put *args
     end
 
+    # @note This is sugar, see (#delete)
     def self.delete *args
       Diplomat::Kv.new.delete *args
     end

data/lib/diplomat/rest_client.rb

@@ -4,14 +4,16 @@ require 'json'
 module Diplomat
   class RestClient
 
-    def initialize api_client=nil
-      start_connection api_client
+    def initialize api_connection=nil
+      start_connection api_connection
     end
 
     private
 
-    def start_connection api_client=nil
-      @conn = api_client ||= Faraday.new(:url => Diplomat::url) do |faraday|
+    # Build the API Client
+    # @param api_connection [Faraday::Connection,nil] supply mock API Connection
+    def start_connection api_connection=nil
+      @conn = api_connection ||= Faraday.new(:url => Diplomat::url) do |faraday|
         faraday.request  :url_encoded
         faraday.response :logger
         faraday.adapter  Faraday.default_adapter

data/lib/diplomat/service.rb

@@ -4,11 +4,15 @@ require 'faraday'
 module Diplomat
   class Service < Diplomat::RestClient
 
+    # Get a service by it's key
+    # @param key [String] the key
+    # @return [OpenStruct] all data associated with the service
     def get key
       ret = @conn.get "/v1/catalog/service/#{key}"
       return OpenStruct.new JSON.parse(ret.body).first
     end
 
+    # @note This is sugar, see (#get)
     def self.get *args
       Diplomat::Service.new.get *args
     end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/kv_spec.rb

@@ -12,13 +12,14 @@ describe Diplomat::Kv do
     let(:key_params) { "toast" }
 
     it "GET" do
-      json = JSON.generate({
+      json = JSON.generate([{
         "Key"   => key,
         "Value" => Base64.encode64(key_params),
         "Flags" => 0
-      })
+      }])
+
+      faraday.stub(:get).and_return(OpenStruct.new({ body: json }))
 
-      faraday.stub(:get).and_return(json)
       kv = Diplomat::Kv.new(faraday)
 
       expect(kv.get("key")).to eq("toast")
@@ -26,28 +27,28 @@ describe Diplomat::Kv do
 
     it "PUT" do
 
-      json = JSON.generate({
+      json = JSON.generate([{
         "Key"   => key,
         "Value" => Base64.encode64(key_params),
         "Flags" => 0
-      })
+      }])
 
-      faraday.stub(:get).and_return(json)
-      faraday.stub(:put).and_return(json)
+      faraday.stub(:get).and_return(OpenStruct.new({ body: json }))
+      faraday.stub(:put).and_return(OpenStruct.new({ body: json }))
       kv = Diplomat::Kv.new(faraday)
 
       expect(kv.put(key, key_params)).to eq(key_params)
     end
 
     it "namespaces" do
-      json = JSON.generate({
+      json = JSON.generate([{
         "Key"   => key,
         "Value" => Base64.encode64(key_params),
         "Flags" => 0
-      })
+      }])
 
-      faraday.stub(:get).and_return(json)
-      faraday.stub(:put).and_return(json)
+      faraday.stub(:get).and_return(OpenStruct.new({ body: json }))
+      faraday.stub(:put).and_return(OpenStruct.new({ body: json }))
       kv = Diplomat::Kv.new(faraday)
 
       expect(kv.put("toast/#{key}", key_params)).to eq(key_params)

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require "bundler/setup"
 Bundler.setup
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'diplomat'
 require 'fakes-rspec'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - John Hamelink
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -117,10 +131,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - diplomat.gemspec
 - lib/diplomat.rb
 - lib/diplomat/kv.rb