analogbridge 0.1.0

data/.sample.pryrc

@@ -0,0 +1,3 @@
+AnalogBridge.configure do |config|
+  config.secret_key = "YOUR_SECRET_KEY"
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Analog Bridge
+
+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,227 @@
+# Analog Bridge
+
+[![Build
+Status](https://travis-ci.org/analogbridge/analog-bridge-ruby.svg?branch=master)](https://travis-ci.org/analogbridge/analog-bridge-ruby)
+[![Code
+Climate](https://codeclimate.com/github/analogbridge/analog-bridge-ruby/badges/gpa.svg)](https://codeclimate.com/github/analogbridge/analog-bridge-ruby)
+
+Analog Bridge is comprised of a JavaScript client and REST API which enables
+your users to import analog media directly into your app or website.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "analogbridge", github: "analogbridge/analog-bridge-ruby"
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install analogbridge
+```
+
+## Configure
+
+Once you have your API Keys from Analog Bridge, you can initialize your configuration with your `secret_key` as
+
+```ruby
+AnalogBridge.configure do |config|
+  config.secret_key = "YOUR_SECRET_KEY"
+end
+```
+
+Or
+
+```ruby
+AnalogBridge.configuration.secret_key = "YOUR_SECRET_KEY"
+```
+
+## Usage
+
+### Customer
+
+#### Create Customer
+
+To create a new customer using the API, usage
+
+```ruby
+AnalogBridge::Customer.create(
+  email: "demo@analogbridge.io",
+  shipping: {
+    first_name: "John",
+    last_name: "Smith",
+    address1: "3336 Commercial Ave",
+    city: "Northbrook",
+    state: "IL",
+    zip: "60062",
+    phone: "800-557-3508",
+    email: "demo@analogbridge.io"
+  },
+  metadata: {
+    user_id: "123456",
+  }
+)
+```
+
+#### Retrieve a Customer
+
+We can easily retrieve a customer's details using their `customer_id`, for
+example to find a customer with details with id `cus_12345678`
+
+```ruby
+AnalogBridge::Customer.find("cus_12345678")
+```
+
+#### Retrieve all customers
+
+Analog Bridge provides an interface to retrieve all your customers very easily.
+To retrieve all of your customers, you can use
+
+```ruby
+AnalogBridge::Customer.list(limit: 20, offset: 100)
+```
+
+#### Update a customer
+
+Update an existing customer's information by using the `cus_id` from customer
+creation. Any unprovided parameters will have no effect on the customer object.
+The arguments for this call are mainly the same as for the customer creation
+call.
+
+```ruby
+AnalogBridge::Customer.update(
+  "cus_123456789",
+  email: "newemail@analogbridge.io"
+)
+```
+
+#### Delete a customer
+
+If we need to delete a customer, for example id `cus_123456789`, then we can
+use
+
+```ruby
+AnalogBridge::Customer.delete("cus_123456789")
+```
+
+### Order
+
+#### List all orders
+
+The Analog Bridge API allow us to retrieve all orders by a specific `customer`.
+For example we want to retrieve all `orders` by customer id `cus_12345678`,
+we can use
+
+```ruby
+AnalogBridge::Order.where(customer_id: "cus_12345678")
+```
+
+#### List order details
+
+If we need to retrieve the details for a specific order then we can use
+
+```ruby
+AnalogBridge::Order.where(
+  order_id: "order_12345678",
+  customer_id: "cus_12345678"
+)
+```
+
+#### Retrieve import ready orders
+Once customer orders have been processed and uploaded to our Cloud, they are import-ready for your system.
+To retrieve the list of import ready orders, we can use
+
+```ruby
+AnalogBridge::Order.import_ready
+```
+
+### Product
+
+#### Listing products
+
+To retrieve the `products` simply use the following interface
+
+```ruby
+AnalogBridge::Product.list
+```
+
+## Development
+
+We are following Sandi Metz's Rules for this gem, you can read the
+[description of the rules here]
+(http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers). All new code should follow these rules. If you make changes in a pre-existing
+file that violates these rules you should fix the violations as part of
+your contribution.
+
+### Setup
+
+Clone the repository.
+
+```sh
+git clone https://github.com/analogbridge/analog-bridge-ruby
+```
+
+Setup your environment.
+
+```sh
+bin/setup
+```
+
+Run the test suite
+
+```sh
+bin/rspec
+```
+
+### PlayBox
+
+Setup API keys.
+
+```sh
+cp .sample.pryrc .pryrc
+vim .pryrc
+```
+
+Start your console.
+
+```sh
+bin/console
+```
+
+Start playing with it.
+
+```ruby
+AnalogBridge::Customer.list
+```
+
+## Contributing
+
+First, thank you for contributing! We love pull requests from everyone. By
+participating in this project, you hereby grant the right to grant or transfer
+an unlimited number of non exclusive licenses or sub-licenses to third parties,
+under the copyright covering the contribution to use the contribution by all
+means.
+
+Here are a few technical guidelines to follow:
+
+1. Open an [issue][issues] to discuss a new feature.
+1. Write tests to support your new feature.
+1. Make sure the entire test suite passes locally and on CI.
+1. Open a Pull Request.
+1. [Squash your commits][squash] after receiving feedback.
+1. Party!
+
+[issues]: https://github.com/analogbridge/analog-bridge-ruby/issues
+[squash]: https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/analogbridge.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "analogbridge/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "analogbridge"
+  spec.version       = AnalogBridge::VERSION
+  spec.authors       = ["Eugene Gekhter", "Abu Nashir"]
+  spec.email         = ["eg@gomemorable.com", "abunashir@gmail.com"]
+
+  spec.summary       = %q{Import any analog media format into your cloud app}
+  spec.description   = %q{Enable users to import any analog media format directly into your app with the Analog Bridge API}
+  spec.homepage      = "https://analogbridge.io"
+  spec.license       = "MIT"
+
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.1.9")
+
+  spec.add_dependency "rest-client", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "analogbridge"
+
+# 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

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

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

data/lib/analogbridge.rb

@@ -0,0 +1,9 @@
+require "analogbridge/version"
+require "analogbridge/client"
+require "analogbridge/base"
+require "analogbridge/order"
+require "analogbridge/product"
+require "analogbridge/customer"
+
+module AnalogBridge
+end

data/lib/analogbridge/base.rb

@@ -0,0 +1,11 @@
+module AnalogBridge
+  class Base
+    def self.method_missing(method_name, *arguments, &block)
+      if new.respond_to?(method_name, include_private: false)
+        new.send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/analogbridge/client.rb

@@ -0,0 +1,46 @@
+require "rest-client"
+require "analogbridge/configuration"
+require "analogbridge/response"
+
+module AnalogBridge
+  class Client
+    attr_reader :http_method, :end_point, :attributes
+
+    def initialize(http_method, end_point, attributes = {})
+      @end_point = end_point
+      @http_method = http_method
+      @attributes = attributes
+    end
+
+    def execute
+      Response.new(execute_api_request).parse
+    end
+
+    private
+
+    def execute_api_request
+      RestClient::Request.execute(
+        method: http_method,
+        url: api_end_point,
+        payload: attributes,
+        user: AnalogBridge.configuration.secret_key,
+      )
+    end
+
+    def api_end_point
+      [AnalogBridge.configuration.api_host, end_point].join("/")
+    end
+  end
+
+  def self.get_resource(end_point)
+    Client.new(:get, end_point).execute
+  end
+
+  def self.post_resource(end_point, attributes)
+    Client.new(:post, end_point, attributes).execute
+  end
+
+  def self.delete_resource(end_point)
+    Client.new(:delete, end_point).execute
+  end
+end

data/lib/analogbridge/configuration.rb

@@ -0,0 +1,22 @@
+module AnalogBridge
+  class Configuration
+    attr_accessor :api_base, :api_version, :secret_key
+
+    def initialize
+      @api_base ||= "https://api.analogbridge.io"
+      @api_version ||= "v1"
+    end
+
+    def api_host
+      [api_base, api_version].join("/")
+    end
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/analogbridge/customer.rb

@@ -0,0 +1,31 @@
+module AnalogBridge
+  class Customer < AnalogBridge::Base
+    def find(customer_id)
+      AnalogBridge.get_resource(
+        ["customers", customer_id].join("/"),
+      )
+    end
+
+    def list(limit: 20, offset: 0)
+      AnalogBridge.get_resource(
+        "customers?limit=#{limit}&offset=#{offset}",
+      )
+    end
+
+    def create(attributes = {})
+      AnalogBridge.post_resource("customers", attributes).data
+    end
+
+    def update(customer_id, attributes = {})
+      AnalogBridge.post_resource(
+        ["customers", customer_id].join("/"), attributes
+      ).data
+    end
+
+    def delete(customer_id)
+      AnalogBridge.delete_resource(
+        ["customers", customer_id].join("/"),
+      ).data
+    end
+  end
+end