shopify-kaminari 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shopify-kaminari.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,46 @@
+= shopify-kaminari
+
+Extends ShopifyAPI with support for paginating the resources via the Kaminari gem.
+
+== Examples
+
+View code:
+
+    ul
+      - @products.each do |product|
+        li= product.title
+    
+    = paginate @products
+
+To paginate all the products:
+
+    @products = ShopifyAPI::Product.paginate per: 25,
+                                             page: params[:page]
+
+To pass some parameters:
+
+    @products = ShopifyAPI::Product.paginate per: 25,
+                                             page: 1,
+                                             params: {published_status: 'published'}
+
+== Default values
+
+Both the :per and :page params are optional, and default to:
+
+    :per  => 25
+    :page => 1
+
+== Contributing to shopify-mock
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Travis Haynes. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+task :default => [:spec]
+
+desc "runs all specs"
+task :spec do
+  files = Dir[File.expand_path("../spec/**/*_spec.rb", __FILE__)].join(" ")
+  puts files
+  exec "bundle exec rspec #{files}"
+end

data/lib/shopify-kaminari.rb

@@ -0,0 +1,77 @@
+require 'shopify_api'
+
+module ShopifyAPI
+  
+  # add Kaminari pagination support to ShopifyAPI
+  module Kaminari
+    @@per = 25
+    
+    class << self
+      # get limit of rows per page
+      # @return [Integer] the per
+      # @example Get the current per per page
+      #   current_per = ShopifyAPI::Kaminari.per
+      # @api public
+      def per
+        @@per
+      end
+      
+      # set limit of rows to return per page
+      # @param [Integer] value The new limit per row value
+      # @return [Integer] the limit per row
+      # @example Set limit per page to 50
+      #   ShopifyAPI::Kaminari.per = 50
+      # @api public
+      def per=(value)
+        @@per = value
+      end
+    end
+    
+    # paginates a ShopifyAPI::Base resource
+    # @param [Hash, Integer] options Can be either a Hash like this: {:page => Integer, :per => Integer}, or the page number
+    # @return [Array] Array of ShopifyAPI resources
+    # @example Paginate all ShopifyAPI::Product
+    #   @products = ShopifyAPI::Product.page :page => params[:page]
+    # @example Paginate per 15
+    #   @products = ShopifyAPI::Product.page :page => params[:page], :per => 15
+    # @api public
+    def paginate(options = {})
+      options = {:page => options} if options.class == Fixnum
+      options = {} if options.nil?
+      
+      # create params for pagination
+      params = {
+        :page => options[:page] || 1,
+        :per  => options[:per]  || 25
+      }
+      
+      # remove pagination params from options
+      options.delete :page
+      options.delete :per
+      
+      # merge any params from options
+      params = params.merge options[:params] if options.include? :params
+      
+      # remove params from options
+      options.delete :params
+      
+      # create arguments to pass to ActiveResource find
+      args = {:params => params}.merge options
+      
+      # run the query
+      result = self.find :all, args
+      
+      # add instance methods to result Array to support paginating with Kaminari
+      result.instance_eval <<-EVAL
+        def current_page; #{args[:params][:page]}; end
+        def num_pages; #{self.count / args[:params][:per] + 1}; end
+        def limit_value; #{args[:params][:per]}; end
+      EVAL
+      
+      result
+    end
+  end
+  
+end
+
+ShopifyAPI::Base.send :extend, ShopifyAPI::Kaminari

data/shopify-kaminari.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "shopify-kaminari"
+  s.version     = "0.0.1"
+  s.authors     = ["Travis Haynes"]
+  s.email       = ["travis.j.haynes@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Provides shopify_api with pagination support via Kaminari}
+  s.description = %q{Extends ShopifyAPI, adding support to paginate using the Kaminari gem.}
+
+  s.rubyforge_project = "shopify-kaminari"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("shopify_api", [">= 1.2.5"])
+  s.add_dependency("kaminari", [">= 0.12.4"])
+  s.add_dependency("rspec", [">= 2.6.0"])
+end

data/spec/shopify-kaminari_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ShopifyAPI::Kaminari do
+  
+  describe "#per" do
+    it "should default to 25" do
+      described_class.per.should eq 25
+    end
+    it "should persist a custom value" do
+      described_class.per.should_not eq 10
+      described_class.per = 10
+      described_class.per.should eq 10
+    end
+  end
+  
+  describe "#paginate" do
+    it "should respond to current_page" do
+      results = ShopifyAPI::Test.paginate
+      results.should respond_to :current_page
+    end
+    it "should respond to num_pages" do
+      results = ShopifyAPI::Test.paginate
+      results.should respond_to :num_pages
+    end
+    it "should respond to limit_value" do
+      results = ShopifyAPI::Test.paginate
+      results.should respond_to :limit_value
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path("../../lib/shopify-kaminari", __FILE__)
+
+# load support files
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| load f}

data/spec/support/shopify_test_resource.rb

@@ -0,0 +1,13 @@
+module ShopifyAPI
+  class Test < Base
+  end
+end
+
+test_response = { "tests" => [] }.to_json
+
+ActiveResource::HttpMock.respond_to do |mock|
+  mock.get "/tests.json?page=1&per=25", {}, test_response
+  mock.get "/tests/count.json", {}, { "count" => 0 }.to_json
+end
+
+ShopifyAPI::Base.site = "http://localhost"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: shopify-kaminari
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Travis Haynes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: &12318260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *12318260
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: &12317760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *12317760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12317280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *12317280
+description: Extends ShopifyAPI, adding support to paginate using the Kaminari gem.
+email:
+- travis.j.haynes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/shopify-kaminari.rb
+- shopify-kaminari.gemspec
+- spec/shopify-kaminari_spec.rb
+- spec/spec_helper.rb
+- spec/support/shopify_test_resource.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: shopify-kaminari
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Provides shopify_api with pagination support via Kaminari
+test_files: []