stackreduce 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4b1ab333cc966d1cbb14049a2f8b3f28736d266
-  data.tar.gz: ecaf8ffe8ee054a7ad07f7fa5f754abb4ef8ac04
+  metadata.gz: caff3906b88f3558b9d17e19b65f146ccb734e83
+  data.tar.gz: df221397de65bee887e7034954051c4b51892eca
 SHA512:
-  metadata.gz: b6c142ebae519abd08879f5dbf9299494a215d1f2076be1709951d8b2185a1a64c11bfee717b22824b61156bf5d03ea77de72ca2400d746d1610b2ff77f104d8
-  data.tar.gz: c9265eadea26652c0d6fb90a1802bd438b55e23ebb7f243c5fdc70807ad49df12ae0dbe7e16dd670bc1d19a4031f32f94319934e890d0397c8ed34cebfc2359d
+  metadata.gz: 4afbd26e3b6c8b0993a1bf777f8694cdb6a776d85549a89b4c19d3f7f4fe447ec9b24a071a567ef5b2775dbc73682ede2344a18211ffa443bdfadd2e913c6c18
+  data.tar.gz: 968e38d3ce61dfb0b4d9da9736d5bc7a7aec32b2eb44c79e7bda8eedb4657f67280c553963bb1e54c1e9e9e7b7844d4b46ccac831773a0cee33c2506c8cf3af8

data/README.md

@@ -1,10 +1,26 @@
-# Stackreduce
+# Stackreduce API Wrapper
 
-TODO: Write a gem description
 
-## Installation
 
-Add this line to your application's Gemfile:
+
+Stackreduce gem its a Rails API Wrapper for [Stackreduce.com](http://www.stackreduce.com/)
+A simple solutions for pushing your data from your rails app
+
+[![Code Climate](https://codeclimate.com/github/stackreduce/stackreduce.png)](https://codeclimate.com/github/stackreduce/stackreduce)
+[![Gem Version](https://badge.fury.io/rb/stackreduce.png)](http://badge.fury.io/rb/stackreduce)
+
+### RDocs
+
+You can view the Stackreduce documentation in RDoc format here:
+
+http://rubydoc.info/github/stackreduce/stackreduce/master/frames
+
+
+### Issue tracker
+https://github.com/stackreduce/stackreduce/issues
+
+## Getting started
+Add it to your Gemfile:
 
     gem 'stackreduce'
 
@@ -16,10 +32,54 @@ Or install it yourself as:
 
     $ gem install stackreduce
 
+## Create a config file
+From console run the generator:
+	
+    $ rails g stackreduce:config
+
+It will create a config file under your 
+
+	config/initializers/stackreduce_config.rb
+
+Edit your config file and add your applications id and token:
+
+    Stackreduce.configure do |config|
+	  config.app_id = "YOUR_APP_ID"
+	  config.token = "YOUR_APP_TOKEN"
+	end
+
 ## Usage
+Push a new stack:
 
-TODO: Write usage instructions here
+	Stackreduce.push User.all		
 
+or create a stack with a name:
+
+	Stackreduce.push User.all, :stack => "My awesome stack"
+
+
+
+## Seed en example Stack
+Push a new demo stack:
+
+Will generate an demo stack with users named "My Users Stack"
+	
+	Stackreduce.seed :users => "My Users Stack"
+	
+Will generate an demo stack with users named "My Products Stack"	
+	
+	Stackreduce.seed :products => "My Products Stack"
+
+Defaults: Will generate an demo stack with users
+	
+	Stackreduce.seed
+
+
+
+## Tested with
+	Rails 4.0.0
+	ruby 2.0.0p195 (2013-05-14 revision 40734) [x86_64-darwin12.3.0]
+	
 ## Contributing
 
 1. Fork it
@@ -27,3 +87,10 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Released under the MIT license
+see the file License.
+
+Created by Yannis Kolovos (https://github.com/msroot)

data/lib/generators/stackreduce/config_generator.rb

@@ -0,0 +1,16 @@
+module Stackreduce
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies Stackreduce configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'stackreduce_config.rb', 'config/initializers/stackreduce_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/stackreduce/templates/stackreduce_config.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+Stackreduce.configure do |config|
+  # Your applications id. Where you save the stacks. 
+  # This can be found under applications page
+  config.app_id = ""
+  # Your applications secret token. 
+  # This can be found under applications page
+  config.token = ""
+end

data/lib/stackreduce.rb

@@ -1,5 +1,67 @@
-require "stackreduce/version"
+require 'active_support'
+require 'active_support/configurable'
+require 'active_support/inflector'
 
 module Stackreduce
-  # Your code goes here...
-end
+  extend ActiveSupport::Autoload
+  
+  # Use ActiveSupport::Autoload for better performance 
+  # autoload all required classes
+  autoload :Version
+  autoload :Exceptions
+  autoload :Stack
+  autoload :Seed
+  
+  # User from rails initializer
+  # ==== Examples
+  # Stackreduce.configure do |config|
+  #   config.token = "my_very_big_token"
+  #   config.app_id = "my_applications_id"
+  # end
+  def self.configure
+    yield self
+  end
+
+  # Applications token 
+  # find in applications settings. 
+  # we use it for saving the stack
+  # ==== Examples
+  # Stackreduce.token
+  include ActiveSupport::Configurable
+  config_accessor :app_id, :token
+
+    # Parses the given array to json
+  # ==== Arguments
+  # * +data+ - Array
+  # ==== Examples
+  # Stackreduce.parse Client.includes(:address).limit(10)
+  # Stackreduce.parse User.all
+  def self.parse(data)
+    Stackreduce::Stack.parse(data)
+  end
+  
+  # Main api call method
+  # ==== Arguments
+  # * +data+ - Array
+  # ==== Examples
+  # Stackreduce.push Client.includes(:address).limit(10)
+  # Stackreduce.push User.all
+  # Stackreduce.push User.all, :stack => "My awesome stack"
+  def self.push(data=nil, options = {})
+    Stackreduce::Stack.push(data, options)
+  end
+  
+
+  # Seeding demo stacks
+  # ==== Arguments
+  # * +:users+ - String
+  # * +:products+ - String  
+  # ==== Examples
+  # Stackreduce.seed
+  # Stackreduce.seed :users => "My Users Stack"
+  # Stackreduce.seed :products => "My Products Stack"
+  def self.seed(options = {})
+    Stackreduce::Seed.seed(options)
+  end
+  
+end

data/lib/stackreduce/exceptions.rb

@@ -0,0 +1,10 @@
+module Stackreduce
+
+  class StackreduceException < Exception
+  end
+  
+  def self.exception e
+    raise StackreduceException.new e
+  end
+  
+end

data/lib/stackreduce/seed.rb

@@ -0,0 +1,62 @@
+require 'faker'
+require 'stackreduce/exceptions'
+require 'active_model'
+
+module Stackreduce
+  class Seed
+
+    class Seeduser
+      include ActiveModel::Model
+      attr_accessor :name, :city, :email, :country, :state
+    end
+    
+    class Seedproduct
+      include ActiveModel::Model
+      attr_accessor :name, :color, :duns_number, :company_name, :department
+    end
+    
+    def self.seed_users(stack)
+      users = []
+      50.times do 
+        users <<  Seeduser.new(
+        :name=>Faker::Name.name,
+        :city=>Faker::Address.city, 
+        :country=>Faker::Address.country,
+        :state=>Faker::Address.state,
+        :email=>Faker::Internet.email
+        )
+      end
+      Stackreduce.push(users, :stack=> stack)
+    end
+    
+
+    
+    def self.seed_products(stack)
+      products = []
+      50.times do 
+        products <<  Seedproduct.new(
+        :name=>Faker::Commerce.product_name,
+        :color=>Faker::Commerce.color, 
+        :duns_number=>Faker::Company.duns_number,
+        :company_name=>Faker::Company.name,
+        :department=>Faker::Commerce.department
+        )
+      end
+      Stackreduce.push(products, :stack=> stack)
+    end
+    
+    
+
+    def self.seed(options)
+      if options[:users]  
+        seed_users(options[:users]) 
+      elsif options[:products] 
+        seed_products(options[:products]) 
+      else
+        seed_users("SEEDED: Demo Users Stack")
+      end
+    end
+
+    
+  end
+end

data/lib/stackreduce/stack.rb

@@ -0,0 +1,53 @@
+require 'json'
+require 'net/http'
+require 'stackreduce/exceptions'
+
+module Stackreduce
+
+  class Stack
+    
+    END_POINT_URL = "http://www.stackreduce.com/api/v1/stacks.json"
+    
+    def self.config_is_valid? #:nodoc:
+      !(Stackreduce.token.blank? or Stackreduce.app_id.blank?)
+    end
+    
+    
+    def self.validate_config! #:nodoc:
+      Stackreduce.exception("Config is not valid: #{Stackreduce.config.inspect}") unless config_is_valid?
+    end
+
+
+    def self.parse(data_array)
+      data = nil
+      begin
+        data =  ActiveSupport::JSON.encode(data_array)
+      rescue e
+        Stackreduce.exception e
+      end
+      data
+    end
+
+    
+    def self.push(data, options)
+      validate_config!      
+      data = parse(data)
+      # we use :stack for argument here but rails expecting :name
+      stack = options[:stack] ||= nil
+      
+      params = {'token' => Stackreduce.token,'app_id' => Stackreduce.app_id,'stack_data' => data}
+      params.merge!('name' => stack) unless stack.nil?
+
+      uri = URI(END_POINT_URL)
+      res = Net::HTTP.post_form(uri, params)
+      
+      handle_response res
+    end
+
+    
+    def self.handle_response res #:nodoc:
+      res.code == "200" ? ActiveSupport::JSON.decode(res.body) : Stackreduce.exception("Response: #{res.inspect}") 
+    end
+    
+  end
+end

data/lib/stackreduce/version.rb

@@ -1,3 +1,3 @@
 module Stackreduce
-  VERSION = "0.0.1"
+  VERSION = "0.0.2".freeze
 end

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: stackreduce
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- John Kolovos
+- Yannis Kolovos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,23 +94,50 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a gem description
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: aruba
+  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'
+description: Stackreduce.com API Wrapper
 email:
 - yannis.kolovos@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
-- .gitignore
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- lib/stackreduce.rb
+- lib/generators/stackreduce/config_generator.rb
+- lib/generators/stackreduce/templates/stackreduce_config.rb
+- lib/stackreduce/exceptions.rb
+- lib/stackreduce/seed.rb
+- lib/stackreduce/stack.rb
 - lib/stackreduce/version.rb
-- stackreduce.gemspec
-homepage: ''
+- lib/stackreduce.rb
+homepage: http://www.stackreduce.com
 licenses:
 - MIT
 metadata: {}
@@ -66,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -77,5 +160,5 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Write a gem summary
+summary: Stackreduce gem its a Rails API Wrapper for Stackreduce.com
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in stackreduce.gemspec
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 John Kolovos
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/stackreduce.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'stackreduce/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "stackreduce"
-  spec.version       = Stackreduce::VERSION
-  spec.authors       = ["John Kolovos"]
-  spec.email         = ["yannis.kolovos@gmail.com"]
-  spec.description   = %q{Write a gem description}
-  spec.summary       = %q{Write a gem summary}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end