giftbit-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 598bd714828681e4294bc0f30325973c2be875fda9f7225a47793494b80c7481
+  data.tar.gz: f693634c944e63e093f4ecadd8089cc8603cf90c5067e69509751939515a6f12
+SHA512:
+  metadata.gz: 891bb572b519ac62ddf15a8d137dcaf027b8125505976ba4077a8e60868e2b06a612a2e848cc298bffdeac71ffe18ff41a62ed024d429570c5c6da412dabcb82
+  data.tar.gz: bd187302c2a881c2d94dd72ee9c03d1784e71ae6cc57ba08910cc5e3e14ee7874f31823f26a4423cabde0301296b0f548f456f7fbd62d2d6534f750b1b3cd99b

data/.gitignore

@@ -0,0 +1,11 @@
+.idea/
+*.gem
+/bin
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fakhir.shad@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in giftbit-rails-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Fakhir Shad
+
+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,142 @@
+# giftbit-rails Gem
+
+Wrapper for [Giftbit](https://www.giftbit.com/giftbitapi/) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'giftbit-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install giftbit-rails
+
+## Usage
+
+Initialize Giftbit request in your app
+
+    Giftbit::Request.new(your_api_key, your_api_url)
+    
+#### Ping
+
+    response = Giftbit::Ping.ping
+    
+#### Brand
+
+List all Brands
+
+    response = Giftbit::Brand.all
+    
+Retrieve Brand
+
+    response = Giftbit::Brand.show(id: 'brand_code')
+    
+#### Region
+
+List all Regions
+
+    response = Giftbit::Region.all
+    
+#### Campaign
+
+Create Campaign (params can be found [here](https://www.giftbit.com/giftbitapi/#/reference/1/campaign/create-campaign))
+
+    response = Giftbit::Campaign.create({
+                                          "gift_template": "XDKHE",
+                                          "contacts": [
+                                            {
+                                              "firstname": "Perry",
+                                              "lastname": "Johnson",
+                                              "email": "pjohnson@giftbit.com"
+                                            },
+                                            {
+                                              "firstname": "Rita",
+                                              "lastname": "Robson",
+                                              "email": "rrobson@giftbit.com"
+                                            }
+                                          ],
+                                          "price_in_cents": 5000,
+                                          "brand_codes": [
+                                            "itunesus",
+                                            "amazonus"
+                                          ],
+                                          "expiry": "2018-11-01",
+                                          "id": "clientProvidedGiftId_abc123"
+                                        })
+                                        
+Retrieve Campaign by id or uuid
+
+Using id
+
+    response = Giftbit::Campaign.find(id: 'campaign_id')
+    
+Using uuid
+
+    response = Giftbit::Campaign.find(uuid: 'campaign_uuid')
+    
+#### Funds
+
+Retrieve funding information
+
+    response = Giftbit::Fund.all
+    
+Add funds through Credit Card (params can be found [here](https://www.giftbit.com/giftbitapi/#/reference/1/funds/add-funds-through-credit-card))
+
+    response = Giftbit::Fund.create({
+                                      "currencyisocode": "USD",
+                                      "fund_amount_in_cents": 25000,
+                                      "id": "clientProvidedId_abc123"
+                                    })
+                                    
+#### Gifts
+
+List all Gifts (params can be found [here](https://www.giftbit.com/giftbitapi/#/reference/1/gifts/list-gifts))
+
+    response = Giftbit::Gift.all
+
+Retrieve a particular Gift                                    
+                                    
+    response = Giftbit::Gift.find(uuid: 'gift_uuid')
+    
+Resend Gift
+
+    response = Giftbit::Gift.resend(uuid: 'gift_uuid', resend: true)
+    
+Cancel Gift
+
+    response = Giftbit::Gift.cancel(uuid: 'gift_uuid')
+    
+#### Links
+
+Retrieve shortlinks by id or uuid
+
+Using id
+
+    response = Giftbit::Link.find(id: 'link_id')
+    
+Using uuid
+
+    response = Giftbit::Link.find(uuid: 'link_uuid')
+    
+#### Marketplace
+
+    response = Giftbit::Marktetplace.all    
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fakhir-shad/giftbit-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the giftbit-rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fakhir-shad/giftbit-rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/giftbit-rails.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "giftbit-rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "giftbit-rails"
+  spec.version       = Giftbit::VERSION
+  spec.authors       = ["Fakhir Shad", "Muaaz Rafi"]
+  spec.email         = ["fakhir.shad@hotmail.com", "muaazrafi@gmail.com"]
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.summary       = %q{Giftbit API wrapper}
+  spec.description   = %q{A simple Ruby wrapper for Giftbit API}
+  spec.homepage      = "https://github.com/fakhir-shad/giftbit"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "httparty", "~> 0.13.7"
+end

data/lib/giftbit-rails.rb

@@ -0,0 +1,13 @@
+require 'giftbit-rails/marketplace'
+require 'giftbit-rails/link'
+require 'giftbit-rails/gift'
+require 'giftbit-rails/fund'
+require 'giftbit-rails/campaign'
+require 'giftbit-rails/region'
+require 'giftbit-rails/brand'
+require 'giftbit-rails/ping'
+require 'giftbit-rails/request'
+require 'giftbit-rails/error'
+
+module Giftbit
+end

data/lib/giftbit-rails/brand.rb

@@ -0,0 +1,16 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Brand < Request
+    class << self
+      def all *args
+        params = extract_params args
+        fire_get("/brands", params)
+      end
+      def find *args
+        params = raise_id_error args
+        fire_get "/brands/#{params[:id]}", params
+      end
+    end
+  end
+end

data/lib/giftbit-rails/campaign.rb

@@ -0,0 +1,17 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Campaign < Request
+    class << self
+      def create *args
+        params = extract_params args
+        fire_post("/campaign", params)
+      end
+      def find *args
+        params = raise_id_or_uuid_error args
+        id = params[:id] || params[:uuid]
+        fire_get "/campaign/#{id}", params
+      end
+    end
+  end
+end

data/lib/giftbit-rails/error.rb

@@ -0,0 +1,12 @@
+module Giftbit
+  class Error < StandardError; end
+  class TimeoutError < StandardError; end
+  class UnprocessableEntity < StandardError; end
+  class BadRequest < StandardError; end
+  class Unauthorized < StandardError; end
+  class Forbidden < StandardError; end
+  class CreditCardFailure < StandardError; end
+  class TooManyRequests < StandardError; end
+  class InternalServiceError < StandardError; end
+  class ServiceUnavailable < StandardError; end
+end

data/lib/giftbit-rails/fund.rb

@@ -0,0 +1,16 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Fund < Request
+    class << self
+      def all *args
+        params = extract_params args
+        fire_get "/funds", params
+      end
+      def create *args
+        params = extract_params args
+        fire_post "/funds", params
+      end
+    end
+  end
+end

data/lib/giftbit-rails/gift.rb

@@ -0,0 +1,25 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Gift < Request
+    class << self
+      def all *args
+        params = extract_params args
+        fire_get "/gifts", params
+      end
+      def find *args
+        params = raise_uuid_error args
+        fire_get "/gifts/#{uuid}", params
+      end
+      def resend *args
+        params = raise_uuid_error args
+        (raise argument_error "resend") if params[:resend].blank?
+        fire_put "/gifts/#{uuid}", params
+      end
+      def cancel *args
+        raise_uuid_error args
+        fire_delete "/gifts/#{uuid}", {}
+      end
+    end
+  end
+end

data/lib/giftbit-rails/link.rb

@@ -0,0 +1,11 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Link < Request
+    def self.find *args
+      params = raise_id_or_uuid_error args
+      id = params[:id] || params[:uuid]
+      fire_get "/links/#{id}", params
+    end
+  end
+end

data/lib/giftbit-rails/marketplace.rb

@@ -0,0 +1,9 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Marketplace < Request
+    def self.all
+      fire_get "/marketplace", {}
+    end
+  end
+end

data/lib/giftbit-rails/ping.rb

@@ -0,0 +1,9 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Ping < Request
+    def self.ping
+      fire_get "/ping", {}
+    end
+  end
+end

data/lib/giftbit-rails/region.rb

@@ -0,0 +1,10 @@
+require 'giftbit-rails/request'
+
+module Giftbit
+  class Region < Request
+    def self.all *args
+      params = extract_params args
+      fire_get "/regions", params
+    end
+  end
+end

data/lib/giftbit-rails/request.rb

@@ -0,0 +1,44 @@
+require 'httparty'
+require 'giftbit-rails/util'
+
+module Giftbit
+  class Request
+
+    include HTTParty
+
+    def initialize key, url
+      raise self.argument_error("api_key and api_url") if key.blank? || url.blank?
+      self.class.base_uri url
+      self.class.headers({'Content-Type' => 'application/json', 'Authorization' => "Bearer #{key}"})
+    end
+
+    class << self
+      include Util
+
+      %w(fire_get fire_delete).each do |fire|
+        define_method(fire) do |url, args|
+          cater_exception fire, url, args, true
+        end
+      end
+
+      %w(fire_post fire_put).each do |fire|
+        define_method fire do |url, args|
+          cater_exception fire, url, args, false
+        end
+      end
+
+      private
+
+        def cater_exception fire, url, args, query
+          begin
+            args.reject!{ |arg| arg['id'] || arg['uuid'] }
+            params = query ? {query: args} : {body: args.to_json}
+            response = send(fire.split('_')[1], url, params)
+            extract_errors response
+          rescue Net::OpenTimeout, Net::ReadTimeout, Timeout::Error => e
+            raise ::Giftbit::TimeoutError.new(e.message)
+          end
+        end
+    end
+  end
+end

data/lib/giftbit-rails/util.rb

@@ -0,0 +1,43 @@
+module Giftbit
+  module Util
+    def argument_error(name)
+      name ? ArgumentError.new("#{name} is required!") : ArgumentError.new
+    end
+
+    def extract_params(args)
+      args.last.is_a?(::Hash) ? args.pop.with_indifferent_access : {}
+    end
+
+    def raise_uuid_error args
+      params = extract_params(args)
+      argument_error "uuid" if params[:uuid].blank?
+      params
+    end
+
+    def raise_id_error args
+      params = extract_params(args)
+      argument_error "id" if params[:id].blank?
+      params
+    end
+
+    def raise_id_or_uuid_error args
+      params = extract_params(args)
+      id = params[:id] || params[:uuid]
+      argument_error "id or uuid" if id.blank?
+      params
+    end
+
+    def extract_errors response
+      parsed_response = response.parsed_response
+      raise Giftbit::BadRequest.new(parsed_response) if response.code == 400
+      raise Giftbit::Unauthorized.new(parsed_response) if response.code == 401
+      raise Giftbit::CreditCardFailure.new(parsed_response) if response.code == 402
+      raise Giftbit::Forbidden.new(parsed_response) if response.code == 403
+      raise Giftbit::UnprocessableEntity.new(parsed_response) if response.code == 422
+      raise Giftbit::TooManyRequests.new(parsed_response) if response.code == 429
+      raise Giftbit::InternalServiceError.new(parsed_response) if response.code == 500
+      raise Giftbit::ServiceUnavailable.new(parsed_response) if response.code == 503
+      parsed_response
+    end
+  end
+end

data/lib/giftbit-rails/version.rb

@@ -0,0 +1,3 @@
+module Giftbit
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: giftbit-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fakhir Shad
+- Muaaz Rafi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: A simple Ruby wrapper for Giftbit API
+email:
+- fakhir.shad@hotmail.com
+- muaazrafi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- giftbit-rails.gemspec
+- lib/giftbit-rails.rb
+- lib/giftbit-rails/brand.rb
+- lib/giftbit-rails/campaign.rb
+- lib/giftbit-rails/error.rb
+- lib/giftbit-rails/fund.rb
+- lib/giftbit-rails/gift.rb
+- lib/giftbit-rails/link.rb
+- lib/giftbit-rails/marketplace.rb
+- lib/giftbit-rails/ping.rb
+- lib/giftbit-rails/region.rb
+- lib/giftbit-rails/request.rb
+- lib/giftbit-rails/util.rb
+- lib/giftbit-rails/version.rb
+homepage: https://github.com/fakhir-shad/giftbit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Giftbit API wrapper
+test_files: []