mashery_rails 0.6.2 → 0.6.3

data/.gitignore

@@ -3,4 +3,5 @@ pkg
 .#*
 doc/
 coverage/
-measurements/
+measurements/
+*.gem

data/.travis.yml

@@ -1,12 +1,4 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 1.9.2
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
   - rbx-19mode
-  - ruby-head
-  - jruby-head
-  - 1.8.7
-  - ree

data/README.md

@@ -1,9 +1,8 @@
 # mashery_rails
 
-[![Coverage Status](https://coveralls.io/repos/farleyknight/masheri/badge.png)](https://coveralls.io/r/farleyknight/masheri)
-
+[![Coverage Status](https://coveralls.io/repos/farleyknight/mashery_rails/badge.png)](https://coveralls.io/r/farleyknight/mashery_rails)
 [![Build Status](https://travis-ci.org/farleyknight/mashery_rails.png?branch=master)](https://travis-ci.org/farleyknight/mashery_rails)
-
+[![Code Climate](https://codeclimate.com/github/farleyknight/mashery_rails.png)](https://codeclimate.com/github/farleyknight/mashery_rails)
 
 A Rails library for the [Mashery API](http://support.mashery.com/docs/mashery_api).
 
@@ -41,23 +40,86 @@ host: "api.mashery.com"
 
 Note this doesn't distinguish between development, testing, production, etc. If you really need that functionality, open a new issue.
 
-## Usage
+## JSON-RPC API
 
 The central data objects are all listed on the [RPC API documentation page](http://support.mashery.com/docs/read/mashery_api/20/API_Objects), and should be supported. However, [fetching objects](http://support.mashery.com/docs/read/mashery_api/20/Fetching_Objects) are the main & typically only supported method for each of these objects. If you feel you want to support more methods, feel free to create a pull request.
 
-
 ### `all`
 
-Fetch all objects of a particular type.
+Fetch the first 100 objects of a particular type. The 100 objects constraint is caused by [Mashery](http://support.mashery.com/docs/read/mashery_api/20/Query_Language):
+
+> Query results are always paginated.  There is a limit of fetching 100 records at one time.  By default, only the first 100 records are returned.
 
 ```ruby
 Mashery::Member.all #=>
 ```
 
+### `find_each`
+
+Much like `ActiveRecord::Base.find_each`, this will take a block and auto-paginate the object set, working around the 100 items per page limitation stated above.
+
+```ruby
+Mashery::Member.find_each {|m| m.do_something! }
+```
+
 ### `first`
 
-Fetch the first object of a particular type.
+Fetch the first object of a particular type. This is effectively setting "ITEMS 1" and reifying that object.
 
 ```ruby
 Mashery::Member.first #=>
 ```
+
+### `count`
+
+The total number of objects.
+
+```ruby
+Mashery::Member.count #=>
+```
+
+## Query Language
+
+Mashery has a basic SQL-like Query Language. This library provides basic AREL-like functionality to build those queries. One small, but important difference is lack of lazy loading. These methods produce queries, but you have to call `all` in order to retrieve the objects.
+
+### `select`
+
+Change the SELECT fragment of the query.
+
+```ruby
+Mashery::Member.select("name") #=>
+```
+
+### `where`
+
+Change the WHERE fragment of the query.
+
+```ruby
+Mashery::Member.where(name: "User Name")
+
+#=> SELECT * FROM members WHERE name = 'User Name' ITEMS 100
+```
+
+### `items`
+
+Change the ITEMS fragment of the query.
+
+```ruby
+Mashery::Member.items(10)
+
+#=> => SELECT * FROM members ITEMS 10
+```
+
+### `page`
+
+Change the PAGE fragment of the query.
+
+```ruby
+Mashery::Member.page(10)
+
+#=> SELECT * FROM members PAGE 10 ITEMS 100
+```
+
+## REST API
+
+Mashery's REST API are mostly calls based on service objects.

data/Rakefile

@@ -1,9 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 # Added by devtools
 require 'devtools'
 Devtools.init_rake_tasks
 
 Bundler::GemHelper.install_tasks
 
-task :build_gem do
-  system "gem build --directory=pkg/"
-end
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/mashery/exceptions.rb

@@ -21,7 +21,7 @@ module Mashery
 
   class ParamMissing < Exception
     def initialize(param)
-      super "Couldn't determine Mashery #{param.inspect}! Please check your config/masheri.yml"
+      super "Couldn't determine Mashery #{param.inspect}! Please check your config/mashery.yml"
     end
   end
 

data/lib/mashery/generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+module Mashery
+  class InstallGenerator < Rails::Generators::Base
+    def create_initializer_file
+      config = %Q{---\nsite_id: '123'\nkey: "abc"\nsecret: "xyz"\nhost: "api.mashery.com"}
+      create_file "config/mashery.yml", config
+    end
+  end
+end

data/lib/mashery/rails.rb

@@ -3,7 +3,7 @@ module Mashery
     if File.exists? rails_config
       load_config! rails_config
     else
-      raise MissingConfig.new
+      # raise MissingConfig.new
     end
   end
 
@@ -12,7 +12,7 @@ module Mashery
   end
 
   class Engine < ::Rails::Engine
-    initializer "load_masheri_config" do
+    initializer "load_mashery_config" do
       Mashery.load_rails_config!
     end
   end

data/lib/mashery/rpc_client/base.rb

@@ -15,6 +15,10 @@ module Mashery
         default_query.all
       end
 
+      def self.select(argument)
+        default_query.select(argument)
+      end
+
       def self.items(argument)
         default_query.items(argument)
       end
@@ -31,6 +35,12 @@ module Mashery
         default_query.find_each(&block)
       end
 
+      def self.first
+        new(standard_query.items(1).all.items[0])
+      end
+
+      protected
+
       def self.standard_query
         Mashery.rpc.query_builder(self).from(object_type).items(100)
       end
@@ -39,10 +49,6 @@ module Mashery
         standard_query
       end
 
-      def self.first
-        new(standard_query.items(1).all.items[0])
-      end
-
       def self.object_type
         self.name.underscore.split('/').last.pluralize
       end

data/lib/mashery/version.rb

@@ -0,0 +1,3 @@
+module Mashery
+  VERSION = "0.6.3"
+end

data/lib/mashery.rb

@@ -16,11 +16,13 @@ require 'mashery/rest_client'
 require 'mashery/query_builder'
 require 'mashery/rest_client/query'
 
-
 require 'mashery/member'
 require 'mashery/key'
 require 'mashery/service'
 
+require 'mashery/rails'
+require 'mashery/generator'
+
 module Mashery
   @@config = nil
 
@@ -49,7 +51,3 @@ module Mashery
     Mashery.rest.activity(activity_type, service_id, options)
   end
 end
-
-if defined?(Rails)
-  require 'mashery/rails'
-end

data/mashery_rails.gemspec

@@ -1,6 +1,8 @@
+require File.expand_path("../lib/mashery/version", __FILE__)
+
 Gem::Specification.new do |s|
   s.name                      = "mashery_rails"
-  s.version                   = File.read("VERSION")
+  s.version                   = Mashery::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors                   = ["Farley Knight"]

data/spec/fixtures/config.no_key.yml

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

data/spec/fixtures/config.no_secret.yml

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

data/spec/fixtures/config.no_site_id.yml

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

data/spec/fixtures/config.yml

@@ -2,4 +2,4 @@
 site_id: "12345"
 secret: "super_secret"
 key: "abcde"
-host: "masheri.example.com"
+host: "mashery.example.com"

data/spec/spec_helper.rb

@@ -38,7 +38,7 @@ RSpec.configure do |config|
       key:       key,
       secret:    secret,
       signature: signature,
-      host:      "masheri.example.com",
+      host:      "mashery.example.com",
     })
 
     Mashery.config = config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mashery_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -79,7 +79,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - config/devtools.yml
 - config/flay.yml
 - config/flog.yml
@@ -90,6 +89,7 @@ files:
 - lib/mashery.rb
 - lib/mashery/config.rb
 - lib/mashery/exceptions.rb
+- lib/mashery/generator.rb
 - lib/mashery/key.rb
 - lib/mashery/local.rb
 - lib/mashery/member.rb
@@ -101,7 +101,7 @@ files:
 - lib/mashery/rpc_client/base.rb
 - lib/mashery/rpc_client/response.rb
 - lib/mashery/service.rb
-- masheri.gemspec
+- lib/mashery/version.rb
 - mashery_rails.gemspec
 - spec/fixtures/config.no_host.yml
 - spec/fixtures/config.no_key.yml
@@ -117,7 +117,6 @@ files:
 - spec/mashery/service_spec.rb
 - spec/mashery_spec.rb
 - spec/spec_helper.rb
-- tasks/mashery.thor
 homepage: http://github.com/farleyknight/mashery_rails
 licenses:
 - MIT
@@ -131,6 +130,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 967152834943881282
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/VERSION

@@ -1 +0,0 @@
-0.6.2

data/masheri.gemspec

@@ -1,26 +0,0 @@
-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/tasks/mashery.thor

@@ -1,200 +0,0 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-
-# XXX: only do this when the task has not been installed
-$: << 'lib'
-
-require 'mashery'
-
-module Mashery
-  class CLI < Thor
-    namespace :mashery
-
-    desc "echo VALUE", "Echo the provided value (tests connectivity and authentication)"
-    def echo(value)
-      run { ok(::Mashery.client.echo(value)) }
-    end
-
-  protected
-    def run(&block)
-      site_id = ENV['MASHERY_SITE_ID'] or
-        raise Exception, "Please set the MASHERY_SITE_ID environment variable."
-      key = ENV['MASHERY_API_KEY'] or
-        raise Exception, "Please set the MASHERY_API_KEY environment variable."
-      secret = ENV['MASHERY_SHARED_SECRET'] or
-        raise Exception, "Please set the MASHERY_SHARED_SECRET environment variable."
-      ::Mashery.test_mode = ENV['MASHERY_PRODUCTION_MODE'].blank?
-      ::Mashery.logger.level = Logger::DEBUG
-      ::Mashery.client = ::Mashery::Client.new(site_id, key, secret)
-      begin
-        yield
-      rescue ::Mashery::HttpException => e
-        error("HTTP error: #{e.message}")
-      rescue ::Mashery::JsonRpcException => e
-        error(e.message)
-      rescue ::Mashery::ValidationException => e
-        e.errors.each {|err| warn("#{err['field']}: #{err['message']}")}
-        error("Unable to execute method due to validation errors")
-      end
-    end
-
-    def warn(msg)
-      say_status :WARN, msg, :yellow
-    end
-
-    def ok(msg)
-      say_status :OK, msg
-    end
-
-    def error(msg)
-      say_status :ERROR, msg, :red
-    end
-
-    def debug(msg)
-      say_status :DEBUG, msg, :cyan
-    end
-  end
-
-  class MemberCLI < CLI
-    namespace 'mashery:member'
-
-    desc "create USERNAME DISPLAY_NAME EMAIL [--fields ...]", "Create a member"
-    method_option :fields, :type => :hash
-    def create(username, display_name, email)
-      run do
-        begin
-          member = ::Mashery::Member.create(username, display_name, email, options[:fields])
-          ok("Member #{member.username} created")
-        rescue ::Mashery::DuplicateObjectException
-          error("The username #{username} has already been claimed")
-        end
-      end
-    end
-
-    desc "fetch USERNAME", "Fetch a member"
-    def fetch(username)
-      run do
-        member = ::Mashery::Member.fetch(username)
-        if member
-          ok("Member #{username} found")
-          say(member.to_yaml)
-        else
-          warn("Member #{username} not found")
-        end
-      end
-    end
-
-    desc "addrole USERNAME ROLE_ID", "Assign a role to a member"
-    def addrole(username, role_id)
-      run do
-        member = ::Mashery::Member.fetch(username)
-        if member
-          role = ::Mashery::Role.fetch(role_id.to_i)
-          if role
-            member.add_role(role)
-            ok("Role #{role.name} assigned to member #{username}")
-          else
-            warn("Role #{role_id} not found")
-          end
-        else
-          warn("Member #{username} not found")
-        end
-      end
-    end
-
-    desc "rmrole USERNAME ROLE_ID", "Revoke a role from a member"
-    def rmrole(username, role_id)
-      run do
-        member = ::Mashery::Member.fetch(username)
-        if member
-          role = ::Mashery::Role.fetch(role_id.to_i)
-          if role
-            member.remove_role(role)
-            ok("Role #{role.name} revoked from member #{username}")
-          else
-            warn("Role #{role_id} not found")
-          end
-        else
-          warn("Member #{username} not found")
-        end
-      end
-    end
-
-    desc "delete USERNAME", "Delete a member"
-    def delete(username)
-      run do
-        ::Mashery::Member.delete(username)
-        ok("Member #{username} deleted")
-      end
-    end
-  end
-
-  class KeyCLI < CLI
-    namespace 'mashery:key'
-
-    desc "create SERVICE_KEY USERNAME [--fields ...]", "Create a key"
-    method_option :fields, :type => :hash
-    def create(service_key, username)
-      run do
-        key = ::Mashery::Key.create(service_key, username, options[:fields])
-        ok("Key #{key.id} created for member #{username} and service #{service_key}")
-      end
-    end
-
-    desc "fetch ID", "Fetch a key"
-    def fetch(id)
-      run do
-        key = ::Mashery::Key.fetch(id.to_i)
-        if key
-          ok("Key #{id} found")
-          say(key.to_yaml)
-        else
-          warn("Key #{id} not found")
-        end
-      end
-    end
-
-    desc "delete ID", "Delete a key"
-    def delete(id)
-      run do
-        ::Mashery::Key.delete(id.to_i)
-        ok("Key #{id} deleted")
-      end
-    end
-  end
-
-  class RoleCLI < CLI
-    namespace 'mashery:role'
-
-    desc "create NAME [--fields ...]", "Create a role"
-    method_option :fields, :type => :hash
-    def create(name)
-      run do
-        role = ::Mashery::Role.create(name, options[:fields])
-        ok("Role #{role.id} created with name #{name}")
-      end
-    end
-
-    desc "fetch ID", "Fetch a role"
-    def fetch(id)
-      run do
-        role = ::Mashery::Role.fetch(id.to_i)
-        if role
-          ok("Role #{id} found")
-          say(role.to_yaml)
-        else
-          warn("Role #{id} not found")
-        end
-      end
-    end
-
-    desc "delete ID", "Delete a role"
-    def delete(id)
-      run do
-        ::Mashery::Role.delete(id.to_i)
-        ok("Role #{id} deleted")
-      end
-    end
-  end
-end