⚠️ OBSOLETE. DO NOT USE! A free and open source Bitcoin ecommerce platform, with several representative clients (online shop, admin etc). Uses Dropwizard, HAL, MongoDB etc
Home Page: http://multibit.org
License: Other
Developer, Director, Dad
For the past 30 years I’ve been a professional developer in a variety of languages. I’ve worked in a wide variety of sectors including aviation, telecommunications, government, distributed ledger, charity, financial and so on.
While I’m able to design a reasonable user interface I much prefer to work on back end and low-level systems.
You might want to take a look at my hid4java project or review my blog.
One key feature for MBM is to provide a paywall for digital media. This could respond with a 402 Payment Required and could have a rel="payment" as an associated link structure.
Staff will need to communicate with each other to co-ordinate actions involving customers. This could be done out of band through email, but this approach
A secure internal messaging system could be built up from the Atmosphere framework since a common use case for this is a chat window. This could
In order to authenticate and authorise requests against a standard
As a platform client
I want to apply these guidelines and support the Warden HMAC Ruby gem
Estimated time (days): 0.5
Acceptance Criteria
Scenario 1: Title
Given a GET request with an AuthHMAC header
And some valid corresponding data
When I attempt to authenticate
Then I should authenticate
In order to limit the possibility of a DoS attack against the MBM platform all requests should be subjected to upper and lower limits of use see Coding Horror: Rate Limiting and Coding Horror: Designing for Evil.
Given that MBM is designed for anonymity, this should be tied into the HMAC authentication api key so that requests from a particular client can be monitored.
Viewing various open source projects, Spring is becoming the juggernaut it was meant to replace. So far Dropwizard has removed the need for much of the Spring framework, but dependency injection is still useful - perhaps Guice can assist with it?
Have a read of articles stemming from An Analysis Pattern for Order and Shipment of a Product
Any code relying on a cookie will need to provide a notice indicating how cookies are used.
In order to administer the Cart entity
As a Customer
I want to perform CRUD operations
Estimated time (days): 2
Acceptance Criteria
Scenario 1: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a GET request against /cart is issued with Customer credentials
Then the response will contain a HAL representation of all Carts owned by the Customer
Done?
Scenario 2: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a POST request against /cart is issued with Customer credentials
And the request contains a valid CreateCart entity represented in HAL
Then the response will contain a HAL representation of the new Cart
Done?
Scenario 3: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a PUT request against /cart/{cartId} is issued with Customer credentials
And the request contains a valid UpdateCart entity represented in HAL
Then the response will contain a HAL representation of the updated Cart
Done?
Scenario 4: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a DELETE request against /cart/{cartId} is issued with Customer credentials
Then the response will contain a confirmation of the delete
Done?
Questions that need answering are:
In order to reduce currency volatility risk
As a customer
I want to see a countdown timer during checkout
Estimated time (days): 1
Acceptance Criteria
Scenario 1: Making payment
Given a shopping cart with items
And the payment page
When I confirm the order
Then a timer will start against the online quote
And if I navigate away and come back the timer will continue from the original starting point
Require a way of binding user stories and acceptance tests together. This will allow continuous creation of business value in an agile manner.
Considered JBehave, Instinct, JUnit only, cuke4duke and others (see this question on Stack Overflow), and Spock seems the right way to go for me. As a useful side effect it introduces an additional JVM language (Groovy) into the mix which will stimulate greater learning.
Require a feature branch to explore how it can be integrated into the existing code.
Require a wiki entry (or blog article) detailing how to deploy MBM to the EC2 platform.
The write up should emphasise the use of Amazon scripts (perhaps supply them as part of the download?) and which instances are most suitable and secure.
Have a read of the following articles:
UX
Fix ConcurrentHashMap using the info in this article
Require a method of managing an Access Control List (ACL) within the Dropwizard environment. Something like the Spring Security approach, but blended with the simple @Auth annotation.
The intention is to restrict access based on the Role and Authority so that customers can get access to their private information through the public port. Staff will perform their operations against the restricted port (specific IP addresses, permitted access hours, permitted information etc).
Need to have documentation on how to get this thing live.
As an administrator I want to import a large collection of items using an industry standard format (or at least a very common one recognised by other ecommerce platforms) so that I don't have much hassle trying MBM out.
Require support for samples of digital downloads of video and audio. HTML5 offers a way of integrating this directly into the browser.
Supporting articles
Various API methods need authentication support. HMAC is probably the easiest to support as a general case.
Completed parts
Remaining work
In order to administer the User entity
As an administrator
I want to perform CRUD operations
Estimated time (days): 2
Acceptance Criteria
Scenario 1: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a GET request against /user is issued with admin credentials
Then the response will contain a HAL representation of all Users (paged)
Done? Yes
Scenario 2: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a POST request against /user is issued with admin credentials
And the request contains a valid CreateUser entity represented in HAL
Then the response will contain a HAL representation of the new User
Done?
Scenario 3: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a PUT request against /user/{userId} is issued with admin credentials
And the request contains a valid UpdateUser entity represented in HAL
Then the response will contain a HAL representation of the updated User
Done?
Scenario 4: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a DELETE request against /user/{userId} is issued with admin credentials
Then the response will contain a confirmation of the delete
Done?
Require support for a variety of logistics companies (Parcel2Go, DHL, FedEx etc)
Provide an eco-system that allows plugins to satisfy these requirements in the clients.
Getting shipping costs via the Parcel2Go API
Getting shipping costs via Fedex
HAL+JSON and HAL+XML has a support framework in HalBuilder that could offer the right balance between simple resource representation and sufficiently well-described linking to allow a HATEOAS approach.
See the HAL IETF draft
Provide a proof of concept with User and Customer entities.
Should the platform provide a security image and/or code word during checkout to improve customer confidence?
Require additional types of accounts: Memo, Detail and Summary (see Martin Fowler's Analysis Patterns)
Could an OpenId or OpenAuth login be used to locate a better product match for the customer, if such details are permitted?
In order to administer the Item entity
As an Administrator
I want to perform CRUD operations
Estimated time (days): 2
Acceptance Criteria
Scenario 1: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a GET request against /item is issued with admin credentials
Then the response will contain a HAL representation of all Items owned by the admin
Done?
Scenario 2: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a POST request against /item is issued with admin credentials
And the request contains a valid CreateItem entity represented in HAL
Then the response will contain a HAL representation of the new Item
Done?
Scenario 3: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a PUT request against /item/{itemId} is issued with admin credentials
And the request contains a valid UpdateItem entity represented in HAL
Then the response will contain a HAL representation of the updated Item
Done?
Scenario 4: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a DELETE request against /item/{itemId} is issued with admin credentials
Then the response will contain a confirmation of the delete
Done?
In order to administer the Role entity
As an administrator
I want to perform CRUD operations
Estimated time (days): 0.5 (relying on previously created User patterns)
Acceptance Criteria
Scenario 1: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a GET request against /role is issued with admin credentials
Then the response will contain a HAL representation of all Roles
Done?
Scenario 2: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a POST request against /role is issued with admin credentials
And the request contains a valid CreateRole entity represented in HAL
Then the response will contain a HAL representation of the new Role
Done?
Scenario 3: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a PUT request against /role/{roleId} is issued with admin credentials
And the request contains a valid UpdateRole entity represented in HAL
Then the response will contain a HAL representation of the updated Role
Done?
Scenario 4: Developer level acceptance
Given a running MBM platform
And a local in-memory database
When a DELETE request against /role/{RoleId} is issued with admin credentials
Then the response will contain a confirmation of the delete
Done?
Clients will rely on JavaScript, which in turn depends on various possible support libraries.
Major choices include:
Minor choices include:
Objective is to create a simple minimalistic UI that can be used as both a demonstrator and a real-life operational component.
Supporting articles
StackOverflow X vs Y
Require a wiki entry (or blog article) detailing how to deploy MBM to the Heroku platform.
The write up should emphasise the use of Heroku scripts (perhaps supply them as part of the download?) and which instances are most suitable and secure.
Replace getInstance() with newBuilder() to follow the Guava convention
Prefix builder methods using 'with'
Require a mechanism to allow the local database to be patched and populated safely.
The following approach could be used (includes client UI and platform operations):
For rollback the following process could be used (includes client UI and platform operations):
The returns and refunds processes need research to cover
Introduce the "master-develop" branching strategy.
Requires
Need to determine how trading in foreign currencies is reported. Spot rate at time? Later? VAT? Seek advice from accountant, community etc
JSP client admin needs to support a collection of URIs to pass in as a model for head.jspf, cdn-scripts.jspf and so on.
This removes the need for mbm-scripts.jspf since it's now redundant.
This will give rise to a need to storing local preferences on the client since this kind of configuration is confined to clients rather than being provided at a platform level.
The 3x4 grid offers a potentially useful HTML5 clients
Need to research how the searching for products will be done.
Main candidates are:
Output from the search egnine, could be made to conform to OpenSearch which is a typical interpretation of rel="search" and offers a standard response format.
The satoshi client provides a mechanism to sign arbitrary text with the private key of a given address. Certain use cases make this worthwhile for a merchant:
The client must have a strong motivation to jump through this hoop so could be made part of a warranty agreement.
Consider how MBM could be used to support
Need to decide on an application-level communication protocol for the platform. This will provide the main interface to the platform and needs to be easily understood by a wide variety of clients.
Candidates include:
Supporting research links
How to GET a cup of coffee
BigCommerce API to ease compatibility with traditional ecommerce solutions?
When entering the text details of a product, it is important to do the following:
Candidates include Freemarker, Markdown, Mustache.
Would need to offer support for conversion from other formats such as HTML.
Supporting articles
Related issue:
Reports can be provided for a variety of purposes:
Users will expect them to be customisable to
Need a generic approach to this, and to include recommendations for stationery and so on
The final artifacts should be available in Maven Central. This will require registration and obtaining a suitable GPG key to sign the final artifacts. This key needs to be securely held outside of version control to allow genuine MBM releases to be distinguished from forks.
Consider how 2-factor authentication could be implemented with MBM, or obviated if possible.
As an alternative to a bulk import, a digital product (audio, video, document) should be uploaded. A smooth interface to this would involve drag and drop and upload (similar to GMail file attach).
Supporting articles:
Consider a minimalistic approach for the JSP and JavaScript clients. Intention to provide an easy to use interface by a smartphone or tablet with access to a bitcoin wallet. The image load time should be as low as possible.
Supporting links
Shift icons - icon font
Riloadr - optimised loading of images through JavaScript on jQuery
Require a client-side mechanism that allows a user to see a walk-through of how to use MBM:
Supporting articles
In order to "some reason or business value"
As a "type of user"
I want "some feature"
Estimated time (days): 0.5, 1, 2, 3, 5, ?
Acceptance Criteria
Scenario 1: Title
Given [context]
And [some more context]...
When [event]
Then [outcome]
And [another outcome]...
When discussing, remember INVEST:
See the Extreme Programming notes.
The Java JSP client has drifted from the current MBM platform RESTful API. Once the communication protocol has been decided then the client code needs to be updated to use it.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
