square_rails 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02dc33d2fc3eb2eb1a7f5650c05f51a81e341f8f
+  data.tar.gz: 421bb48c8b230e7353658defccb56ed430308a92
+SHA512:
+  metadata.gz: f7bb3f323d6c6e0d1662a8da40074c3ac4030281ea10d2d22a1fd5da596bdb9dae932cfc867ead3ea1382086f76780db728448c49f528d03d1d4412d73009935
+  data.tar.gz: 3cf8a335a2ba47836dce4b0d5f6e454384b0296d3cf13b9b9349afbe38b385a860c934566c09201c587115cf75861abda0ed379c995de559bb9ab3dfd1fa299e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Quinn McLaughlin
+
+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/README.md

@@ -0,0 +1,96 @@
+# SquareRails
+
+An easy way to work with Square's Connect API from Ruby on Rails.
+
+## Demonstration: 
+### Access a Square Merchant's Account, Locations and Payments
+In four lines of code. After config :)
+
+#### 1. Install the square_rails gem
+
+Add this line to your application's Gemfile (or create a new blank rails app, then add it):
+
+```ruby
+gem 'square_rails', :git => 'git://github.com/qmclaugh/square_rails.git'
+```
+
+And then execute:
+
+	$ bundle
+  
+#### 2. Enter your Square Connect application credentials
+
+Execute the following to copy `\config\initalizers\square_rails_init.rb` into your application:
+  
+	$ rake square_rails:init
+  
+Open `\config\intializers\square_rails_init.rb` in your Rails application and **enter your Square Application ID and Application Secret**.  If you don't have these, go to [https://developers.squareup.com/](https://developers.squareup.com/), sign up for a Square account and then go to [Manage Apps](https://developers.squareup.com/apps). Open or create a new Square Connect app there and you'll see both.
+
+#### 3. Tell Square Connect where your app is running
+
+Continue from your application's page (via the [Manage Apps](https://developers.squareup.com/apps) page).  On your application's page there is a field named **Redirect URL**.  For now, enter 
+
+	http://localhost:3000/square_callback
+
+in that field. 
+
+#### 4. Connect to a merchant's Square account
+
+Start your rails server
+
+	$ rails server
+
+Open [http://localhost:3000/square_authorize](http://localhost:3000/square_authorize). You'll be redirect to a Square, asked to log in if you aren't already and asked to authorize the app you just created.  Once you do, you'll be redirected to the URL you entered in #3, which should be your local application. Your access token is shown on this page.  **Copy your access token to the clipboard now** so you can use it below.
+
+If you have a merchant account that has actual payments and locations in it, log into this on here if you can.
+
+You can see your authorized app here: [https://squareup.com/dashboard/apps/my-apps](https://squareup.com/dashboard/apps/my-apps).  You can also revoke the access token here.  Log out of your Square account here (upper left) if you want to be re-prompted to log in when authorizing at [http://localhost:3000/square_authorize](http://localhost:3000/square_authorize).
+
+#### 5. Look up a Merchant's Locations and Payments
+
+Open a Rails console:
+
+	$ rails console
+
+Set your access token - you copied it to your clipboard above yes? (if not just [authorize again](http://localhost:3000/square_authorize))
+
+```ruby
+token = 'YOUR ACCESS TOKEN FROM STEP 4'
+```
+Now pull your merchant's locations:
+
+```ruby
+locations = SquareRails.locations(token)
+```
+The method above returns an array of locations.  So let's use the first one, and grab the payments for it.
+
+```ruby
+location = locations.first
+payments = SquareRails.payments(token,location)
+```
+Hello Money.
+
+Note that money is stored in cents - and there are more things you'll want to know. Read the [Square Connect API reference](https://docs.connect.squareup.com/api/connect/v1/) for the details...
+
+## Usage in your application
+
+TODO: Structure and clarify this section.
+
+The above demo should make a lot clear.  For the initial merchant authentication, make sure to set `SQUARE_AFTER_AUTHORIZE_PATH` in `\config\initalizers\square_rails_init.rb`.  Set this to a path within your application and store your user's access token in the database there (it will be in `session[:square_access_token]`).  Then there is no text page shown; the user is just redirected back into your application.  
+
+If you are using the devise gem for authentication, you could migrate the User model to include a new field `square_access_token` and store the Square Connect assigned access token there after the user logs in. Then you can get to locations etc with `current_user.square_access_token`. Don't hit the Connect API every time..!
+
+**Once in production** or on staging, make sure to change the Square Connect side **Redirect URL** that you set in Step 3... no localhost here.
+
+## TODO:
+
+Lots.  Error handling. Add `options` hash for payments. Hook up tons of remaining Square Connect API methods.  Add convenience methods, like converting money to decimals and back. Set up for webhooks.  Make everything super easy to use.  Further Connect API for Dummies style documentation :) 
+
+
+## Contributing
+
+1. Fork it ( https://github.com/qmclaugh/square_rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/app/controllers/square_rails/square_integration_controller.rb

@@ -0,0 +1,55 @@
+module SquareRails
+  class SquareIntegrationController < ApplicationController
+    def authorize
+      redirect_to "#{SQUARE_CONNECT_HOST}/oauth2/authorize?client_id=#{SQUARE_APP_ID}"
+    end
+
+    def callback
+
+      session[:square_access_token] = nil
+      session[:square_auth_response] = nil
+      authorization_code = params['code']
+
+      if authorization_code
+
+        # Provide the code in a request to the Obtain Token endpoint
+        oauth_request_body = {
+          'client_id' => SQUARE_APP_ID,
+          'client_secret' => SQUARE_APP_SECRET,
+          'code' => authorization_code,
+          'scope' => SQUARE_SCOPE
+        }
+
+        response = Unirest.post "#{SQUARE_CONNECT_HOST}/oauth2/token",
+                                headers: SQUARE_OAUTH_REQUEST_HEADERS,
+                                parameters: oauth_request_body
+
+        # Extract the returned access token from the response body
+        if response.body.key?('access_token')
+
+          # Here, instead of printing the access token, your application server should store it securely
+          # and use it in subsequent requests to the Connect API on behalf of the merchant.
+          auth_response =  "Access token received and assigned to session[:square_access_token]. The token is: <br><br>#{response.body['access_token']}"
+          session[:square_access_token] = response.body['access_token']
+        # The response from the Obtain Token endpoint did not include an access token. Something went wrong.
+        else
+          auth_response = 'Code exchange failed!'
+        end
+
+      # The request to the Redirect URL did not include an authorization code. Something went wrong.
+      else
+        auth_response = 'Authorization failed!'
+      end
+
+      if SQUARE_AFTER_AUTHORIZE_PATH.present?
+        session[:square_auth_response] = auth_response
+        redirect_to SQUARE_AFTER_AUTHORIZE_PATH
+      else
+        render text: auth_response.html_safe
+      end
+    end
+
+    def webhook
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "square_rails"
+include SquareRails
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  get 'square_authorize' => 'square_rails/square_integration#authorize'
+  get 'square_callback' => 'square_rails/square_integration#callback'
+end
+  

data/lib/square_rails.rb

@@ -0,0 +1,39 @@
+require "square_rails/version"
+require "square_rails/engine"
+require 'unirest'
+
+module SquareRails
+    
+    #TODO: error handling 
+
+    def self.locations(token)
+      @url = "#{SQUARE_CONNECT_HOST}/v1/me/locations"
+      @token = token
+      self.get_data_from_square
+    end
+
+    def self.payments(token,location)
+      if location.is_a?(Hash)
+        loc_id = location['id']
+      else
+        loc_id = location
+      end
+
+      @url = "#{SQUARE_CONNECT_HOST}/v1/#{loc_id}/payments"
+      @token =token
+      self.get_data_from_square
+    end
+
+    def self.merchant(token)
+      @url = "#{SQUARE_CONNECT_HOST}/v1/me"
+      @token = token
+      self.get_data_from_square
+    end
+
+    def self.get_data_from_square
+      headers = {'Authorization' => 'Bearer ' + @token, 'Accept' => 'application/json', "Content-Type"=> "application/json"}
+      res = Unirest.get @url, headers: headers
+      res.body
+    end
+
+end

data/lib/square_rails/engine.rb

@@ -0,0 +1,17 @@
+module SquareRails
+
+  class Engine < Rails::Engine
+
+    # initialize "team_page.load_app_instance_data" do |app|
+    #   SquareRails.setup do |config|
+    #     config.app_root = app.root
+    #   end
+    # end
+
+    # initialize "team_page.load_static_assets" do |app|
+    #   app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    # end
+
+  end
+
+end

data/lib/square_rails/railtie.rb

@@ -0,0 +1,11 @@
+require 'square_rails'
+require 'rails'
+module RakePlugin
+  class Railtie < Rails::Railtie
+    railtie_name :rake_plugin
+
+    rake_tasks do
+      load "lib/tasks/rake_plugin.rake"
+    end
+  end
+end

data/lib/square_rails/rake_plugin.rb

@@ -0,0 +1,3 @@
+module MyPlugin
+  require 'railtie' if defined?(Rails)
+end

data/lib/square_rails/version.rb

@@ -0,0 +1,3 @@
+module SquareRails
+  VERSION = "0.1.5"
+end

data/lib/tasks/rake_plugin.rake

@@ -0,0 +1,19 @@
+namespace :square_rails do
+  desc "Prep initializer for square_rails."
+  task :init do
+    print "Copy the default square_rails_init.rb to the application config/initializers folder?(y/n): "
+    option = STDIN.gets.strip
+
+    case option
+       when /[^Yy]/
+         abort_message
+    end
+
+    gem_root = Gem.loaded_specs['square_rails'].full_gem_path
+    gem_lib = File.join(gem_root, 'lib/tasks')
+
+    puts "Copying..."
+    cp gem_lib + '/square_rails_init.rb', Rails.root.to_s + '/config/initializers', verbose: false 
+    puts "Done."
+  end
+end

data/lib/tasks/square_rails_init.rb

@@ -0,0 +1,23 @@
+# Your application's ID and secret, available from your application dashboard.
+SQUARE_APP_ID     = 'YOUR APP ID HERE'
+SQUARE_APP_SECRET = 'YOUR APP SECRET HERE'
+
+# Headers to provide to OAuth API endpoints
+SQUARE_OAUTH_REQUEST_HEADERS = {
+  'Authorization' => "Client #{SQUARE_APP_SECRET}",
+  'Accept' => 'application/json',
+  'Content-Type' => 'application/json'
+}
+
+SQUARE_CONNECT_HOST = 'https://connect.squareup.com'
+
+# Set the path you'd like your user to go to after they go to Square's site
+# and authorize your app.
+# Upon redirect, your customer's square access token will be in the session 
+# variable session[:square_access_token]
+
+SQUARE_AFTER_AUTHORIZE_PATH = nil # path to go to after user authorizes, eg '/home/dashboard'
+
+SQUARE_SCOPE = 'PAYMENTS_READ,MERCHANT_PROFILE_READ' # set to desired permissions.  See 
+
+include SquareRails

data/square_rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'square_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "square_rails"
+  spec.version       = SquareRails::VERSION
+  spec.authors       = ["Quinn McLaughlin"]
+  spec.email         = ["quinn@coincidence.net"]
+
+  spec.summary       = %q{Gem to simplify getting started with the Square Connect API.}
+  spec.description   = %q{This gem provides a convenient way for a developer to quickly get to a merchant's data  Add your app ID and secret, update your callback location in the Square Developer Portal and off you go. Based on Square's sinatra examples, https://github.com/square/connect-api-examples}
+  spec.homepage      = "https://github.com/qmclaugh/square_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+  spec.add_dependency "unirest"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.has_rdoc      = false
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: square_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Quinn McLaughlin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: unirest
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem provides a convenient way for a developer to quickly get to
+  a merchant's data  Add your app ID and secret, update your callback location in
+  the Square Developer Portal and off you go. Based on Square's sinatra examples,
+  https://github.com/square/connect-api-examples
+email:
+- quinn@coincidence.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/square_rails/square_integration_controller.rb
+- app/models/.keep
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/square_rails.rb
+- lib/square_rails/engine.rb
+- lib/square_rails/railtie.rb
+- lib/square_rails/rake_plugin.rb
+- lib/square_rails/version.rb
+- lib/tasks/rake_plugin.rake
+- lib/tasks/square_rails_init.rb
+- square_rails.gemspec
+homepage: https://github.com/qmclaugh/square_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Gem to simplify getting started with the Square Connect API.
+test_files: []