mongohq-client 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    mongohq-client (0.0.1)
+      httparty
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    ffi (1.0.11)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.0)
+      guard (>= 1.1)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    json (1.7.3)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    thor (0.15.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  guard
+  guard-rspec
+  mongohq-client!
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/README.md

@@ -0,0 +1,45 @@
+# Mongohq::Client
+
+A simple MongoHQ api client for ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongohq-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongohq-client
+
+## Usage
+
+Require mongohq-client
+
+    require 'mongohq-client'
+
+Authenticate with you apikey
+
+    client = MongoHQClient.from_apikey("youapikey")
+
+Retrieve all your databases
+
+    databases = client.databases
+
+Retrive collections from database
+
+    collections = client.databases.first.collections
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mongohq-client.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+require 'json'
+
+require 'mongohq-client/commons'
+require 'mongohq-client/http'
+require 'mongohq-client/plan'
+require 'mongohq-client/invoice'
+require 'mongohq-client/index'
+require 'mongohq-client/document'
+require 'mongohq-client/collection'
+require 'mongohq-client/database_details'
+require 'mongohq-client/database'
+require 'mongohq-client/client'
+
+module MongoHQClient
+
+  def self.from_apikey(apikey)
+    Client.new apikey
+  end
+
+end

data/lib/mongohq-client/client.rb

@@ -0,0 +1,55 @@
+module MongoHQClient
+
+  class Client
+    include HTTP
+
+    attr_accessor :apikey
+
+    def initialize(apikey)
+      @apikey = apikey
+    end
+
+    def databases
+      json = get("databases")
+
+      db_list = []
+
+      json.each do |db|
+        db_list << Database.new(json: db, apikey: apikey)
+      end
+
+      db_list
+    end
+
+    def invoices
+      json = get("invoices")
+
+      invoices = []
+
+      json.each do |invoice|
+        invoices << Invoice.new(json: invoice)
+      end
+
+      invoices
+    end
+
+    def invoice(id)
+      json = get("invoices/#{id}")
+
+      Invoice.new json: json
+    end
+
+    def plans
+      json = get("plans")
+
+      plans = []
+
+      json.each do |plan|
+        plans << Plan.new(json: plan)
+      end
+
+      plans
+    end
+  end
+
+end

data/lib/mongohq-client/collection.rb

@@ -0,0 +1,43 @@
+module MongoHQClient
+  class Collection
+    include Commons
+    include HTTP
+
+    def documents
+      json = get("databases/#{database}/collections/#{name}/documents")
+
+      documents = []
+
+      json.each do |doc|
+        documents << Document.new(json:doc)
+      end
+
+      documents
+    end
+
+    def document(id)
+      json = get("databases/#{database}/collections/#{name}/documents/#{id}")
+
+      Document.new(json: json)
+    end
+
+    def indexes
+      json = get("databases/#{database}/collections/#{name}/indexes")
+
+      indexes = []
+
+      json.each do |index|
+        indexes << Index.new(json: index)
+      end
+
+      indexes
+    end
+
+    protected
+    def database
+      raise "Invalid database" unless @params[:database]
+      @params[:database]
+    end
+
+  end
+end

data/lib/mongohq-client/commons.rb

@@ -0,0 +1,29 @@
+module MongoHQClient
+  module Commons
+    def method_missing(method, *args)
+      attribute = method.to_s
+      if (attribute.to_s.end_with? '?')
+        attribute = attribute.to_s[0..-2]
+      end
+
+      super.method_missing(method, *args) unless json_hash.has_key? attribute
+
+      return json_hash["#{attribute}"]
+    end
+
+    def initialize(params = {})
+      raise "Invalid json" unless params[:json].is_a? Hash
+      @params = params
+    end
+
+    protected
+    def json_hash
+      @params[:json]
+    end
+
+    def apikey
+      @params[:apikey]
+    end
+
+  end
+end

data/lib/mongohq-client/database.rb

@@ -0,0 +1,32 @@
+module MongoHQClient
+
+  class Database
+    include Commons
+    include HTTP
+
+    def details
+      json = get("databases/#{name}")
+
+      DatabaseDetails.new json: json
+    end
+
+    def collections
+      json = get("databases/#{name}/collections")
+
+      collections = []
+
+      json.each do |col|
+        collections << Collection.new(json: col, apikey: apikey, database: name)
+      end
+
+      collections
+    end
+
+    def collection(col_name)
+      json = get("databases/#{name}/collections/#{col_name}")
+
+      Collection.new(json: json, database: name)
+    end
+
+  end
+end

data/lib/mongohq-client/database_details.rb

@@ -0,0 +1,6 @@
+module MongoHQClient
+  class DatabaseDetails
+    include Commons
+
+  end
+end

data/lib/mongohq-client/document.rb

@@ -0,0 +1,5 @@
+module MongoHQClient
+  class Document
+    include Commons
+  end
+end

data/lib/mongohq-client/http.rb

@@ -0,0 +1,23 @@
+module MongoHQClient
+
+  module HTTP
+
+    def get(uri)
+      puts uri
+      raise "Invalid apikey" unless apikey
+      resp = HTTParty.get("#{base_uri}/#{uri}", query: { :_apikey => apikey } )
+
+      puts resp.body
+
+      #TODO error handling
+
+      JSON.parse(resp.body)
+    end
+
+    protected
+    def base_uri
+      "https://api.mongohq.com"
+    end
+  end
+
+end

data/lib/mongohq-client/index.rb

@@ -0,0 +1,5 @@
+module MongoHQClient
+  class Index
+    include Commons
+  end
+end

data/lib/mongohq-client/invoice.rb

@@ -0,0 +1,5 @@
+module MongoHQClient
+  class Invoice
+    include Commons
+  end
+end

data/lib/mongohq-client/plan.rb

@@ -0,0 +1,5 @@
+module MongoHQClient
+  class Plan
+    include Commons
+  end
+end

data/mongohq-client.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib/', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "mongohq-client"
+  s.version     = "0.0.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rodrigo Saito"]
+  s.email       = ["rodrigo.saito@gmail.com"]
+  s.summary     = "A client for MongoHQ API"
+
+  s.add_dependency("httparty")
+  s.add_dependency("json")
+
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("guard")
+  s.add_development_dependency("guard-rspec")
+  s.add_development_dependency("fakeweb")
+
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split($\)
+end
+

data/spec/mongohq-client/client_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+describe MongoHQClient::Client do
+  let(:client) { MongoHQClient.from_apikey("123456") }
+
+  describe "client creation" do
+
+    it "should return a client with apikey" do
+      client.apikey.should eq("123456")
+    end
+  end
+
+  describe "#databases" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases?_apikey=#{client.apikey}", body: '[{"name":"database1","hostname":"host.mongohq.com","port":27036,"shared":true,"plan":"Micro"},{"name":"database2","hostname":"host2.mongohq.com","port":10075,"shared":true,"plan":"Sandbox"},{"name":"database3","hostname":"staff.mongohq.com","port":10025,"shared":true,"plan":"Sandbox"}]'
+    end
+
+    let(:databases) { client.databases }
+
+    it "should return 3 databases" do
+      databases.size.should eq(3)
+    end
+  end
+
+  describe "#invoices" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/invoices?_apikey=#{client.apikey}", body: '[{"id":12345,"amount":5.0,"balance":0.0,"bill_date":"2012-06-01","is_paid":true},{"id":12346,"amount":5.0,"balance":0.0,"bill_date":"2012-07-01","is_paid":true}]'
+    end
+
+    let(:invoices) { client.invoices }
+
+    it "should return 2 invoice" do
+      invoices.size.should eq(2)
+    end
+
+    it "should return amount" do
+      invoices.first.amount.should eq(5.0)
+    end
+  end
+
+  describe "#invoice" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/invoices/12345?_apikey=#{client.apikey}", body: '{"id":12345,"amount":5.0,"balance":0.0,"bill_date":"2012-06-01","is_paid":true}'
+    end
+
+    let(:invoice) { client.invoice("12345")}
+
+    it "should return a paid invoice" do
+      invoice.is_paid?.should be_true
+    end
+  end
+
+  describe "#plans" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/plans?_apikey=#{client.apikey}", body: '[{"name":"Micro","slug":"micro","price":5,"type":"hosted"},{"name":"Replica Set: Large","slug":"rs_large","price":300,"type":"hosted"}]'
+    end
+
+    let(:plans) { client.plans }
+
+    it "should return plans" do
+      plans.size.should eq(2)
+    end
+  end
+
+end

data/spec/mongohq-client/collection_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe MongoHQClient::Collection do
+  let(:subject) { MongoHQClient::Collection.new json: JSON.parse('{"name":"collection1","count":15,"storageSize":192512,"avgObjSize":2257.866666666667,"indexCount":1,"ok":1.0}'), apikey: "123456", database: "database1" }
+
+  describe "#name" do
+    it_behaves_like "attribute", :name, "collection1"
+  end
+
+  describe "#count" do
+    it_behaves_like "attribute", :count, 15
+  end
+
+  describe "#storageSize" do
+    it_behaves_like "attribute", :storageSize, 192512
+  end
+
+  describe "#avgObjSize" do
+    it_behaves_like "attribute", :avgObjSize, 2257.866666666667
+  end
+
+  describe "#indexCount" do
+    it_behaves_like "attribute", :indexCount, 1
+  end
+
+  describe "#ok" do
+    it_behaves_like "attribute", :ok, 1.0
+  end
+
+  describe "#documents" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1/collections/collection1/documents?_apikey=123456", body: '[{"_id":{"$oid": "4ffde13927bce841321005ec0"},"name":"Test User","updated_at":"2012-07-11 20:25:29 UTC","created_at":"2012-07-11 20:25:29 UTC"}]'
+    end
+
+    it "should return documents" do
+      subject.documents.size.should eq(1)
+    end
+  end
+
+  describe "#document" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1/collections/collection1/documents/4ffde13927bce841321005ec0?_apikey=123456", body: '{"_id":{"$oid": "4ffde13927bce841321005ec0"},"name":"Test User","updated_at":"2012-07-11 20:25:29 UTC","created_at":"2012-07-11 20:25:29 UTC"}'
+    end
+
+    it "should return document by id" do
+      subject.document('4ffde13927bce841321005ec0').name.should eq("Test User")
+    end
+  end
+
+  describe "#indexes" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1/collections/collection1/indexes?_apikey=123456", body: '[{"v":1,"key":{"_id":1},"ns":"database1.collection1","name":"_id_"}]'
+    end
+
+    it "should return indexes" do
+      subject.indexes.size.should eq(1)
+    end
+
+    it "should return ns" do
+      subject.indexes.first.ns.should eq("database1.collection1")
+    end
+  end
+
+end

data/spec/mongohq-client/database_details_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe MongoHQClient::DatabaseDetails do
+  let(:subject) { MongoHQClient::DatabaseDetails.new json: JSON.parse('{"db":"database1","collections":10,"objects":1799,"avgObjSize":353.85881045025013,"dataSize":636592,"storageSize":2314240,"numExtents":17,"indexes":9,"indexSize":147168,"fileSize":251658240,"nsSizeMB":16,"ok":1.0,"name":"database1","hostname":"host.mongohq.com","port":27036,"shared":true,"plan":"Micro"}') }
+
+  describe "#db" do
+    it_behaves_like "attribute", :db, "database1"
+  end
+
+  describe "#collections" do
+    it_behaves_like "attribute", :collections, 10
+  end
+
+  describe "#objects" do
+    it_behaves_like "attribute", :objects, 1799
+  end
+
+  describe "#avgObjSize" do
+    it_behaves_like "attribute", :avgObjSize, 353.85881045025013
+  end
+
+  describe "#dataSize" do
+    it_behaves_like "attribute", :dataSize, 636592
+  end
+
+  describe "#storageSize" do
+    it_behaves_like "attribute", :storageSize, 2314240
+  end
+
+  describe "#numExtents" do
+    it_behaves_like "attribute", :numExtents, 17
+  end
+
+  describe "#indexes" do
+    it_behaves_like "attribute", :indexes, 9
+  end
+
+  describe "#indexSize" do
+    it_behaves_like "attribute", :indexSize, 147168
+  end
+
+  describe "#fileSize" do
+    it_behaves_like "attribute", :fileSize, 251658240
+  end
+
+  describe "#nsSizeMB" do
+    it_behaves_like "attribute", :nsSizeMB, 16
+  end
+
+  describe "#ok" do
+    it_behaves_like "attribute", :ok, 1.0
+  end
+
+  describe "#name" do
+    it_behaves_like "attribute", :name, "database1"
+  end
+
+  describe "#hostname" do
+    it_behaves_like "attribute", :hostname, "host.mongohq.com"
+  end
+
+  describe "#port" do
+    it_behaves_like "attribute", :port, 27036
+  end
+
+  describe "#shared" do
+    it_behaves_like "attribute", :shared, true
+  end
+
+  describe "#plan" do
+    it_behaves_like "attribute", :plan, "Micro"
+  end
+
+end

data/spec/mongohq-client/database_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe MongoHQClient::Database do
+
+  let(:database) { MongoHQClient::Database.new json: JSON.parse('{"name":"database1","hostname":"host.mongohq.com","port":27036,"shared":true,"plan":"Micro"}'), apikey: "123456" }
+
+  describe "#name" do
+    it "should return the name of database" do
+      database.name.should eq("database1")
+    end
+  end
+
+  describe "#hostname" do
+    it "should return hostname of database" do
+      database.hostname.should eq("host.mongohq.com")
+    end
+  end
+
+  describe "#port" do
+    it "should return port of database" do
+      database.port.should eq(27036)
+    end
+  end
+
+  describe "#shared" do
+    it "should return if database is shared" do
+      database.shared?.should be_true
+    end
+  end
+
+  describe "#plan" do
+    it "should return the plan of database" do
+      database.plan.should eq("Micro")
+    end
+  end
+
+  it "should raise error where attribute is invalid" do
+    expect {
+      database.invalid
+    }.to raise_error(NoMethodError)
+  end
+
+  describe "#details" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1?_apikey=123456", body: '{"db":"database1","collections":10,"objects":1799,"avgObjSize":353.85881045025013,"dataSize":636592,"storageSize":2314240,"numExtents":17,"indexes":9,"indexSize":147168,"fileSize":251658240,"nsSizeMB":16,"ok":1.0,"name":"database1","hostname":"host.mongohq.com","port":27036,"shared":true,"plan":"Micro"}'
+    end
+
+    let(:details) { database.details }
+
+    it "should return database details" do
+      details.db.should eq("database1")
+    end
+  end
+
+  describe "#collections" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1/collections?_apikey=123456", body: '[{"name":"collections1","count":0,"storageSize":40960,"avgObjSize":null,"indexCount":1,"ok":1.0},{"name":"collection2","count":15,"storageSize":192512,"avgObjSize":2257.866666666667,"indexCount":1,"ok":1.0},{"name":"collections3","count":162,"storageSize":294912,"avgObjSize":1006.8395061728395,"indexCount":1,"ok":1.0},{"name":"collections4","count":36,"storageSize":8192,"avgObjSize":92.22222222222223,"indexCount":1,"ok":1.0},{"name":"collections5","count":0,"storageSize":8192,"avgObjSize":null,"indexCount":1,"ok":1.0},{"name":"collections6","count":0,"storageSize":8192,"avgObjSize":null,"indexCount":1,"ok":1.0},{"name":"collections7","count":1558,"storageSize":1740800,"avgObjSize":278.9165596919127,"indexCount":1,"ok":1.0}]'
+    end
+
+    let(:collections) { database.collections }
+
+    it "should return collections" do
+      collections.size.should eq(7)
+    end
+  end
+
+  describe "#collection" do
+    before do
+      FakeWeb.register_uri :get, "https://api.mongohq.com/databases/database1/collections/collection1?_apikey=123456", body: '{"ns":"database1.collection1","count":1558,"size":434552,"avgObjSize":278.9165596919127,"storageSize":1740800,"numExtents":4,"nindexes":1,"lastExtentSize":1310720,"paddingFactor":1.009999999999998,"flags":1,"totalIndexSize":81760,"indexSizes":{"_id_":81760},"ok":1.0}'
+    end
+
+    let(:collection) { database.collection "collection1" }
+
+    it "should return collection with details" do
+      collection.ns.should eq("database1.collection1")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fakeweb'
+require 'mongohq-client'
+
+FakeWeb.allow_net_connect = false
+
+shared_examples "attribute" do |attr, expected|
+  it "should return #{attr} attribute" do
+    subject.send(attr).should eq(expected)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongohq-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -113,7 +113,31 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/mongohq-client.rb
+- lib/mongohq-client/client.rb
+- lib/mongohq-client/collection.rb
+- lib/mongohq-client/commons.rb
+- lib/mongohq-client/database.rb
+- lib/mongohq-client/database_details.rb
+- lib/mongohq-client/document.rb
+- lib/mongohq-client/http.rb
+- lib/mongohq-client/index.rb
+- lib/mongohq-client/invoice.rb
+- lib/mongohq-client/plan.rb
+- mongohq-client.gemspec
+- spec/mongohq-client/client_spec.rb
+- spec/mongohq-client/collection_spec.rb
+- spec/mongohq-client/database_details_spec.rb
+- spec/mongohq-client/database_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses: []
 post_install_message: