masheri 0.5.6 → 0.6.0

data/config/rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessControl:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/masheri.rb

@@ -9,12 +9,13 @@ require 'masheri/exceptions'
 require 'masheri/config'
 
 require 'masheri/rpc_client'
+require 'masheri/rpc_client/base'
 require 'masheri/rpc_client/response'
 
 require 'masheri/rest_client'
 require 'masheri/query_builder'
 require 'masheri/rest_client/query'
-require 'masheri/rest_client/base'
+
 
 require 'masheri/member'
 require 'masheri/key'

data/lib/masheri/key.rb

@@ -1,5 +1,5 @@
 module Masheri
-  class Key < RestClient::Base
+  class Key < RpcClient::Base
     attr_accessor(:id, :created, :updated, :service_key, :apikey, :username, :status,
       :rate_limit_ceiling, :qps_limit_ceiling, :rate_limit_exempt, :qps_limit_exempt,
       :required_referer, :secret, :limits, :object_type)

data/lib/masheri/member.rb

@@ -1,5 +1,5 @@
 module Masheri
-  class Member < RestClient::Base
+  class Member < RpcClient::Base
     attr_accessor(:created, :updated, :username, :email, :display_name,
       :uri, :blog, :im, :imsvc, :phone, :company, :address1, :address2,
       :locality, :region, :postal_code, :country_code, :first_name, :last_name,

data/lib/masheri/{rest_client → rpc_client}/base.rb

@@ -1,5 +1,5 @@
 module Masheri
-  class RestClient
+  class RpcClient
     class Base
       def initialize(attributes)
         attributes.each do |key, value|
@@ -44,7 +44,7 @@ module Masheri
       end
 
       def self.object_type
-        self.name.underscore.pluralize
+        self.name.underscore.split('/').last.pluralize
       end
     end
   end

data/lib/masheri/service.rb

@@ -1,5 +1,5 @@
 module Masheri
-  class Service < RestClient::Base
+  class Service < RpcClient::Base
     attr_accessor :service_key, :name, :limits, :created, :updated, :object_type
 
     def activity(options = {})

data/masheri.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name    = "masheri"
+  s.version = File.read("VERSION")
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Farley Knight"]
+  s.date = "2013-09-23"
+  s.email = "farleyknight@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.textile"
+  ]
+
+  s.files = `git ls-files`.split("\n")
+
+  s.homepage = "http://github.com/farleyknight/masheri"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Rails gem for Mashery. Clean config and includes tests with decent test coverage"
+
+  s.add_dependency(%q<activesupport>, [">= 3.1.0"])
+  s.add_dependency(%q<rest-client>, [">= 0"])
+  s.add_dependency(%q<json>, [">= 0"])
+end

data/spec/fixtures/config.no_host.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+key: "abcde"
+secret: "super_secret"

data/spec/fixtures/config.no_key.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+secret: "super_secret"
+host: "masheri.example.com"

data/spec/fixtures/config.no_secret.yml

@@ -0,0 +1,4 @@
+---
+site_id: "12345"
+key: "abcde"
+host: "masheri.example.com"

data/spec/fixtures/config.no_site_id.yml

@@ -0,0 +1,4 @@
+---
+key: "abcde"
+secret: "super_secret"
+host: "masheri.example.com"

data/spec/fixtures/config.yml

@@ -0,0 +1,5 @@
+---
+site_id: "12345"
+secret: "super_secret"
+key: "abcde"
+host: "masheri.example.com"

data/spec/fixtures/services.json

@@ -0,0 +1,3 @@
+
+
+stuff

data/spec/masheri/config_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Masheri::Config do
+  it "should raise an error on lack of key" do
+    expect {
+      Masheri::Config.new("spec/fixtures/config.no_key.yml")
+    }.to raise_error(Masheri::ParamMissing, /key/)
+  end
+
+  it "should raise an error on lack of site_id" do
+    expect {
+      Masheri::Config.new("spec/fixtures/config.no_site_id.yml")
+    }.to raise_error(Masheri::ParamMissing, /site_id/)
+  end
+
+  it "should raise an error on lack of secret" do
+    expect {
+      Masheri::Config.new("spec/fixtures/config.no_secret.yml")
+    }.to raise_error(Masheri::ParamMissing, /secret/)
+  end
+
+  it "should raise an error on lack of host" do
+    expect {
+      Masheri::Config.new("spec/fixtures/config.no_host.yml")
+    }.to raise_error(Masheri::ParamMissing, /host/)
+  end
+
+  it "should have site_id, key, secret, host and signature as attributes" do
+    config = Masheri::Config.new("spec/fixtures/config.yml")
+    expect do
+      config.key
+      config.secret
+      config.signature
+      config.host
+      config.site_id
+    end.to_not raise_error
+  end
+end

data/spec/masheri/member_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Masheri::Member do
+  let(:url) { Masheri.rpc.url }
+
+  let(:items) {
+    [{"name" => "Name"}] * 10
+  }
+
+  let(:params) {
+    {
+      'method' => "object.query",
+      'params' => [query],
+      'id'     => 1
+    }
+  }
+
+  let(:headers) {
+    {
+      "Content-Type"   => "application/json",
+      "Accept"         => "text/plain",
+      "Content-Length" => params.size
+    }
+  }
+
+  let(:json) {
+    {
+      "result" => {
+        "items" => items
+      }
+    }.to_json
+  }
+
+
+  context "with standard query" do
+    let(:query) {
+      "SELECT * FROM members ITEMS 100"
+    }
+
+    it "should grab all the members" do
+      ::RestClient.should_receive(:post).with(url, params.to_json, headers).and_return(json)
+      objects = Masheri::Member.all
+      objects.length.should == 10
+    end
+  end
+
+end

data/spec/masheri/query_builder_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Masheri::QueryBuilder do
+  it "should build a simple query" do
+    builder = Masheri::QueryBuilder.new
+    builder.from("members").to_s.should == "SELECT * FROM members"
+  end
+
+  it "should build a query with pagination" do
+    builder = Masheri::QueryBuilder.new
+    builder.from("members").page(25).items(100).to_s.should == "SELECT * FROM members PAGE 25 ITEMS 100"
+  end
+end

data/spec/masheri/rest_client_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Masheri::RestClient do
+  let(:service_key) do
+    "12345"
+  end
+
+  let(:url) do
+    Masheri::RestClient::Query.new(query_params).url
+  end
+
+  let(:query_params) do
+    {service_id: service_key}.merge(options)
+  end
+
+
+  context "reasonable date range" do
+    let(:options) do
+      {
+        start_date: 1.day.ago,
+        end_date:   0.days.ago,
+        resource:   "developer_activity"
+      }
+    end
+
+    it "should request the service data, given a service key" do
+      ::RestClient.should_receive(:get).with(url).and_return("whatever")
+      Masheri.activity("developer_activity", service_key, options).should == "whatever"
+    end
+  end
+
+  context "invalid date range" do
+    let(:options) do
+      {
+        start_date: 8.day.ago,
+        end_date:   0.days.ago,
+        resource:   "developer_activity"
+      }
+    end
+
+    it "should raise an InvalidDateRange error" do
+      expect do
+        Masheri.activity("developer_activity", service_key, options)
+      end.to raise_error(Masheri::InvalidDateRange)
+    end
+  end
+end

data/spec/masheri/rpc_client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Masheri::RpcClient do
+  let(:query) {
+    "SELECT * FROM whatevers"
+  }
+
+  let(:params) {
+    {
+      'method' => "object.query",
+      'params' => [query],
+      'id'     => 1
+    }
+  }
+
+  let(:headers) {
+    {
+      "Content-Type"   => "application/json",
+      "Accept"         => "text/plain",
+      "Content-Length" => params.size
+    }
+  }
+
+  it "should post to RpcClient with the proper arguments" do
+    ::RestClient.should_receive(:post).with(Masheri.rpc.url, params.to_json, headers).and_return({hello: 'world'}.to_json)
+    Masheri.rpc.query(query)
+  end
+end
+

data/spec/masheri/service_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Masheri::Service do
+  let(:url) { Masheri.rpc.url }
+
+  let(:items) {
+    [{"name" => "Name"}] * 10
+  }
+
+  let(:params) {
+    {
+      'method' => "object.query",
+      'params' => [query],
+      'id'     => 1
+    }
+  }
+
+  let(:headers) {
+    {
+      "Content-Type"   => "application/json",
+      "Accept"         => "text/plain",
+      "Content-Length" => params.size
+    }
+  }
+
+  let(:json) {
+    {
+      "result" => {
+        "items" => items
+      }
+    }.to_json
+  }
+
+  context "with standard query" do
+    let(:query) { "SELECT * FROM services ITEMS 100" }
+
+    it "should grab all the services" do
+      ::RestClient.should_receive(:post).with(url, params.to_json, headers).and_return(json)
+      objects = Masheri::Service.all
+      objects.length.should == 10
+    end
+  end
+
+  context "with pagination query" do
+    let(:query) { "SELECT * FROM services PAGE 3 ITEMS 100"}
+
+    it "should grab the 3rd page of services" do
+      ::RestClient.should_receive(:post).with(url, params.to_json, headers).and_return(json)
+      objects = Masheri::Service.page(3).all
+      objects.length.should == 10
+    end
+  end
+
+  context "with auto-pagination via find_each" do
+    let(:total_pages) { 5 }
+
+    def query(page)
+      if page == 1
+        "SELECT * FROM services ITEMS 100"
+      else
+        "SELECT * FROM services PAGE #{page} ITEMS 100"
+      end
+    end
+
+    def params(page)
+      {
+        'method' => "object.query",
+        'params' => [query(page)],
+        'id'     => 1
+      }
+    end
+
+    def json(page)
+      {
+        "result" => {
+          "total_pages"  => total_pages,
+          "current_page" => page,
+          "items"        => items
+        }
+      }.to_json
+    end
+
+    def headers(page)
+      {
+        "Content-Type"   => "application/json",
+        "Accept"         => "text/plain",
+        "Content-Length" => params(page).size
+      }
+    end
+
+    it "should invoke a new query for each page" do
+      (1..total_pages).each do |n|
+        ::RestClient.should_receive(:post).with(url, params(n).to_json, headers(n)).and_return(json(n))
+      end
+
+      Masheri::Service.find_each do |entry|
+        entry.should be_a(Masheri::Service)
+      end
+    end
+  end
+end